diff --git a/.openapi-generator/configs/gooddata-api-client.yaml b/.openapi-generator/configs/gooddata-api-client.yaml index b00459370..f624c4abd 100644 --- a/.openapi-generator/configs/gooddata-api-client.yaml +++ b/.openapi-generator/configs/gooddata-api-client.yaml @@ -1,5 +1,5 @@ # (C) 2022 GoodData Corporation -generatorName: python +generatorName: python-prior templateDir: /local/.openapi-generator/custom_templates appName: "GoodData api client OpenAPI definition" infoName: "GoodData (generated by OpenAPI Generator)" diff --git a/gooddata-api-client/.openapi-generator/FILES b/gooddata-api-client/.openapi-generator/FILES index 1912bf0d4..65cc7f5f7 100644 --- a/gooddata-api-client/.openapi-generator/FILES +++ b/gooddata-api-client/.openapi-generator/FILES @@ -84,12 +84,15 @@ docs/AlertCondition.md docs/AlertConditionOperand.md docs/AlertDescription.md docs/AlertEvaluationRow.md +docs/AllTimeDateFilter.md +docs/AllTimeDateFilterAllTimeDateFilter.md docs/AllowedRelationshipType.md docs/AnalyticsCatalogCreatedBy.md docs/AnalyticsCatalogTags.md docs/AnalyticsCatalogUser.md docs/AnalyticsModelApi.md docs/AnomalyDetection.md +docs/AnomalyDetectionConfig.md docs/AnomalyDetectionRequest.md docs/AnomalyDetectionResult.md docs/AnomalyDetectionWrapper.md @@ -137,8 +140,17 @@ docs/AutomationVisualExport.md docs/AutomationsApi.md docs/AvailableAssignees.md docs/AvailableDriversApi.md +docs/AwsBedrockAccessKeyAuth.md +docs/AwsBedrockAccessKeyAuthAllOf.md +docs/AwsBedrockProviderConfig.md +docs/AzureFoundryApiKeyAuth.md +docs/AzureFoundryApiKeyAuthAllOf.md +docs/AzureFoundryProviderAuth.md +docs/AzureFoundryProviderConfig.md +docs/BedrockProviderAuth.md docs/BoundedFilter.md docs/CSPDirectivesApi.md +docs/CertificationApi.md docs/ChangeAnalysisParams.md docs/ChangeAnalysisParamsFiltersInner.md docs/ChangeAnalysisRequest.md @@ -150,6 +162,7 @@ docs/ChatHistoryResult.md docs/ChatRequest.md docs/ChatResult.md docs/ChatUsageResponse.md +docs/ClusteringConfig.md docs/ClusteringRequest.md docs/ClusteringResult.md docs/ColumnLocation.md @@ -172,6 +185,8 @@ docs/ComputationApi.md docs/ContentSlideTemplate.md docs/CookieSecurityConfigurationApi.md docs/CoverSlideTemplate.md +docs/CreateKnowledgeDocumentRequestDto.md +docs/CreateKnowledgeDocumentResponseDto.md docs/CreatedVisualization.md docs/CreatedVisualizationFiltersInner.md docs/CreatedVisualizations.md @@ -300,6 +315,7 @@ docs/DeclarativeWorkspacePermissions.md docs/DeclarativeWorkspaces.md docs/DefaultSmtp.md docs/DefaultSmtpAllOf.md +docs/DeleteKnowledgeDocumentResponseDto.md docs/DependencyGraphApi.md docs/DependentEntitiesGraph.md docs/DependentEntitiesNode.md @@ -349,14 +365,19 @@ docs/FilterContextApi.md docs/FilterDefinition.md docs/FilterDefinitionForSimpleMeasure.md docs/FilterViewsApi.md +docs/ForecastConfig.md docs/ForecastRequest.md docs/ForecastResult.md docs/FoundObjects.md docs/Frequency.md docs/FrequencyBucket.md docs/FrequencyProperties.md +docs/GenerateDescriptionRequest.md +docs/GenerateDescriptionResponse.md docs/GenerateLdmRequest.md docs/GenerateLogicalDataModelApi.md +docs/GenerateTitleRequest.md +docs/GenerateTitleResponse.md docs/GeoAreaConfig.md docs/GeoCollectionIdentifier.md docs/GeographicDataApi.md @@ -414,7 +435,7 @@ docs/JsonApiAnalyticalDashboardOutMeta.md docs/JsonApiAnalyticalDashboardOutMetaAccessInfo.md docs/JsonApiAnalyticalDashboardOutRelationships.md docs/JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards.md -docs/JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md +docs/JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md docs/JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins.md docs/JsonApiAnalyticalDashboardOutRelationshipsDatasets.md docs/JsonApiAnalyticalDashboardOutRelationshipsFilterContexts.md @@ -748,6 +769,18 @@ docs/JsonApiLlmEndpointOutWithLinks.md docs/JsonApiLlmEndpointPatch.md docs/JsonApiLlmEndpointPatchAttributes.md docs/JsonApiLlmEndpointPatchDocument.md +docs/JsonApiLlmProviderIn.md +docs/JsonApiLlmProviderInAttributes.md +docs/JsonApiLlmProviderInAttributesModelsInner.md +docs/JsonApiLlmProviderInAttributesProviderConfig.md +docs/JsonApiLlmProviderInDocument.md +docs/JsonApiLlmProviderOut.md +docs/JsonApiLlmProviderOutDocument.md +docs/JsonApiLlmProviderOutList.md +docs/JsonApiLlmProviderOutWithLinks.md +docs/JsonApiLlmProviderPatch.md +docs/JsonApiLlmProviderPatchAttributes.md +docs/JsonApiLlmProviderPatchDocument.md docs/JsonApiMemoryItemIn.md docs/JsonApiMemoryItemInAttributes.md docs/JsonApiMemoryItemInDocument.md @@ -969,13 +1002,20 @@ docs/KeyDriversDimension.md docs/KeyDriversRequest.md docs/KeyDriversResponse.md docs/KeyDriversResult.md +docs/KnowledgeDocumentMetadataDto.md +docs/KnowledgeSearchResultDto.md docs/LDMDeclarativeAPIsApi.md docs/LLMEndpointsApi.md +docs/LLMProvidersApi.md docs/LabelIdentifier.md docs/LabelsApi.md docs/LayoutApi.md +docs/ListKnowledgeDocumentsResponseDto.md docs/ListLinks.md docs/ListLinksAllOf.md +docs/LlmModel.md +docs/LlmProviderAuth.md +docs/LlmProviderConfig.md docs/LocalIdentifier.md docs/LocaleRequest.md docs/ManageDashboardPermissionsRequestInner.md @@ -996,9 +1036,11 @@ docs/MemoryItemUser.md docs/MetadataCheckApi.md docs/MetadataSyncApi.md docs/Metric.md +docs/MetricDefinitionOverride.md docs/MetricRecord.md docs/MetricValueChange.md docs/MetricsApi.md +docs/ModelTestResult.md docs/NegativeAttributeFilter.md docs/NegativeAttributeFilterNegativeAttributeFilter.md docs/Note.md @@ -1014,6 +1056,10 @@ docs/NotificationsMeta.md docs/NotificationsMetaTotal.md docs/ObjectLinks.md docs/ObjectLinksContainer.md +docs/OpenAIProviderConfig.md +docs/OpenAiApiKeyAuth.md +docs/OpenAiApiKeyAuthAllOf.md +docs/OpenAiProviderAuth.md docs/Operation.md docs/OperationError.md docs/OptionsApi.md @@ -1032,6 +1078,7 @@ docs/Over.md docs/PageMetadata.md docs/Paging.md docs/Parameter.md +docs/PatchKnowledgeDocumentRequestDto.md docs/PdfTableStyle.md docs/PdfTableStyleProperty.md docs/PdmLdmRequest.md @@ -1094,6 +1141,7 @@ docs/ResultSpec.md docs/RouteResult.md docs/RsaSpecification.md docs/RulePermission.md +docs/RunServiceCommandRequest.md docs/RunningSection.md docs/SavedVisualization.md docs/ScanRequest.md @@ -1101,11 +1149,15 @@ docs/ScanResultPdm.md docs/ScanSqlRequest.md docs/ScanSqlResponse.md docs/ScanningApi.md +docs/SearchKnowledgeResponseDto.md docs/SearchRelationshipObject.md docs/SearchRequest.md docs/SearchResult.md docs/SearchResultObject.md +docs/SearchStatisticsDto.md docs/SectionSlideTemplate.md +docs/ServiceInfo.md +docs/SetCertificationRequest.md docs/Settings.md docs/SimpleMeasureDefinition.md docs/SimpleMeasureDefinitionMeasure.md @@ -1139,6 +1191,9 @@ docs/TabularExportRequest.md docs/TestConnectionApi.md docs/TestDefinitionRequest.md docs/TestDestinationRequest.md +docs/TestLlmProviderDefinitionRequest.md +docs/TestLlmProviderDefinitionRequestProviderConfig.md +docs/TestLlmProviderResponse.md docs/TestNotification.md docs/TestNotificationAllOf.md docs/TestQueryDuration.md @@ -1152,6 +1207,8 @@ docs/TotalResultHeader.md docs/TranslationsApi.md docs/TriggerAutomationRequest.md docs/TriggerQualityIssuesCalculationResponse.md +docs/UpsertKnowledgeDocumentRequestDto.md +docs/UpsertKnowledgeDocumentResponseDto.md docs/UsageApi.md docs/UserAssignee.md docs/UserContext.md @@ -1185,6 +1242,7 @@ docs/Value.md docs/VisibleFilter.md docs/VisualExportApi.md docs/VisualExportRequest.md +docs/VisualizationConfig.md docs/VisualizationObjectApi.md docs/Webhook.md docs/WebhookAllOf.md @@ -1192,6 +1250,9 @@ docs/WebhookAutomationInfo.md docs/WebhookMessage.md docs/WebhookMessageData.md docs/WebhookRecipient.md +docs/WhatIfMeasureAdjustmentConfig.md +docs/WhatIfScenarioConfig.md +docs/WhatIfScenarioItem.md docs/WidgetSlidesTemplate.md docs/WorkspaceAutomationIdentifier.md docs/WorkspaceAutomationManagementBulkRequest.md @@ -1223,6 +1284,7 @@ gooddata_api_client/api/attributes_api.py gooddata_api_client/api/automation_organization_view_controller_api.py gooddata_api_client/api/automations_api.py gooddata_api_client/api/available_drivers_api.py +gooddata_api_client/api/certification_api.py gooddata_api_client/api/computation_api.py gooddata_api_client/api/cookie_security_configuration_api.py gooddata_api_client/api/csp_directives_api.py @@ -1250,6 +1312,7 @@ gooddata_api_client/api/labels_api.py gooddata_api_client/api/layout_api.py gooddata_api_client/api/ldm_declarative_apis_api.py gooddata_api_client/api/llm_endpoints_api.py +gooddata_api_client/api/llm_providers_api.py gooddata_api_client/api/manage_permissions_api.py gooddata_api_client/api/metadata_check_api.py gooddata_api_client/api/metadata_sync_api.py @@ -1369,11 +1432,14 @@ gooddata_api_client/model/alert_condition.py gooddata_api_client/model/alert_condition_operand.py 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/analytics_catalog_created_by.py gooddata_api_client/model/analytics_catalog_tags.py gooddata_api_client/model/analytics_catalog_user.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 @@ -1415,6 +1481,14 @@ gooddata_api_client/model/automation_slides_export.py gooddata_api_client/model/automation_tabular_export.py gooddata_api_client/model/automation_visual_export.py gooddata_api_client/model/available_assignees.py +gooddata_api_client/model/aws_bedrock_access_key_auth.py +gooddata_api_client/model/aws_bedrock_access_key_auth_all_of.py +gooddata_api_client/model/aws_bedrock_provider_config.py +gooddata_api_client/model/azure_foundry_api_key_auth.py +gooddata_api_client/model/azure_foundry_api_key_auth_all_of.py +gooddata_api_client/model/azure_foundry_provider_auth.py +gooddata_api_client/model/azure_foundry_provider_config.py +gooddata_api_client/model/bedrock_provider_auth.py gooddata_api_client/model/bounded_filter.py gooddata_api_client/model/change_analysis_params.py gooddata_api_client/model/change_analysis_params_filters_inner.py @@ -1427,6 +1501,7 @@ 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_location.py @@ -1447,6 +1522,8 @@ 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/content_slide_template.py gooddata_api_client/model/cover_slide_template.py +gooddata_api_client/model/create_knowledge_document_request_dto.py +gooddata_api_client/model/create_knowledge_document_response_dto.py gooddata_api_client/model/created_visualization.py gooddata_api_client/model/created_visualization_filters_inner.py gooddata_api_client/model/created_visualizations.py @@ -1570,6 +1647,7 @@ gooddata_api_client/model/declarative_workspace_permissions.py gooddata_api_client/model/declarative_workspaces.py gooddata_api_client/model/default_smtp.py gooddata_api_client/model/default_smtp_all_of.py +gooddata_api_client/model/delete_knowledge_document_response_dto.py gooddata_api_client/model/dependent_entities_graph.py gooddata_api_client/model/dependent_entities_node.py gooddata_api_client/model/dependent_entities_request.py @@ -1611,13 +1689,18 @@ gooddata_api_client/model/filter.py gooddata_api_client/model/filter_by.py gooddata_api_client/model/filter_definition.py gooddata_api_client/model/filter_definition_for_simple_measure.py +gooddata_api_client/model/forecast_config.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/generate_description_request.py +gooddata_api_client/model/generate_description_response.py gooddata_api_client/model/generate_ldm_request.py +gooddata_api_client/model/generate_title_request.py +gooddata_api_client/model/generate_title_response.py gooddata_api_client/model/geo_area_config.py gooddata_api_client/model/geo_collection_identifier.py gooddata_api_client/model/get_ai_lake_operation200_response.py @@ -1669,7 +1752,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_created_by.py +gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_certified_by.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 @@ -2003,6 +2086,18 @@ gooddata_api_client/model/json_api_llm_endpoint_out_with_links.py gooddata_api_client/model/json_api_llm_endpoint_patch.py gooddata_api_client/model/json_api_llm_endpoint_patch_attributes.py gooddata_api_client/model/json_api_llm_endpoint_patch_document.py +gooddata_api_client/model/json_api_llm_provider_in.py +gooddata_api_client/model/json_api_llm_provider_in_attributes.py +gooddata_api_client/model/json_api_llm_provider_in_attributes_models_inner.py +gooddata_api_client/model/json_api_llm_provider_in_attributes_provider_config.py +gooddata_api_client/model/json_api_llm_provider_in_document.py +gooddata_api_client/model/json_api_llm_provider_out.py +gooddata_api_client/model/json_api_llm_provider_out_document.py +gooddata_api_client/model/json_api_llm_provider_out_list.py +gooddata_api_client/model/json_api_llm_provider_out_with_links.py +gooddata_api_client/model/json_api_llm_provider_patch.py +gooddata_api_client/model/json_api_llm_provider_patch_attributes.py +gooddata_api_client/model/json_api_llm_provider_patch_document.py gooddata_api_client/model/json_api_memory_item_in.py gooddata_api_client/model/json_api_memory_item_in_attributes.py gooddata_api_client/model/json_api_memory_item_in_document.py @@ -2224,9 +2319,15 @@ gooddata_api_client/model/key_drivers_dimension.py gooddata_api_client/model/key_drivers_request.py gooddata_api_client/model/key_drivers_response.py gooddata_api_client/model/key_drivers_result.py +gooddata_api_client/model/knowledge_document_metadata_dto.py +gooddata_api_client/model/knowledge_search_result_dto.py gooddata_api_client/model/label_identifier.py +gooddata_api_client/model/list_knowledge_documents_response_dto.py gooddata_api_client/model/list_links.py gooddata_api_client/model/list_links_all_of.py +gooddata_api_client/model/llm_model.py +gooddata_api_client/model/llm_provider_auth.py +gooddata_api_client/model/llm_provider_config.py gooddata_api_client/model/local_identifier.py gooddata_api_client/model/locale_request.py gooddata_api_client/model/manage_dashboard_permissions_request_inner.py @@ -2244,8 +2345,10 @@ 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_record.py gooddata_api_client/model/metric_value_change.py +gooddata_api_client/model/model_test_result.py gooddata_api_client/model/negative_attribute_filter.py gooddata_api_client/model/negative_attribute_filter_negative_attribute_filter.py gooddata_api_client/model/note.py @@ -2260,6 +2363,10 @@ gooddata_api_client/model/notifications_meta.py gooddata_api_client/model/notifications_meta_total.py gooddata_api_client/model/object_links.py gooddata_api_client/model/object_links_container.py +gooddata_api_client/model/open_ai_api_key_auth.py +gooddata_api_client/model/open_ai_api_key_auth_all_of.py +gooddata_api_client/model/open_ai_provider_auth.py +gooddata_api_client/model/open_ai_provider_config.py gooddata_api_client/model/operation.py gooddata_api_client/model/operation_error.py gooddata_api_client/model/organization_automation_identifier.py @@ -2272,6 +2379,7 @@ gooddata_api_client/model/over.py gooddata_api_client/model/page_metadata.py gooddata_api_client/model/paging.py gooddata_api_client/model/parameter.py +gooddata_api_client/model/patch_knowledge_document_request_dto.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 @@ -2330,17 +2438,22 @@ gooddata_api_client/model/result_spec.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/search_knowledge_response_dto.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/search_statistics_dto.py gooddata_api_client/model/section_slide_template.py +gooddata_api_client/model/service_info.py +gooddata_api_client/model/set_certification_request.py gooddata_api_client/model/settings.py gooddata_api_client/model/simple_measure_definition.py gooddata_api_client/model/simple_measure_definition_measure.py @@ -2370,6 +2483,9 @@ gooddata_api_client/model/table_warning.py gooddata_api_client/model/tabular_export_request.py gooddata_api_client/model/test_definition_request.py gooddata_api_client/model/test_destination_request.py +gooddata_api_client/model/test_llm_provider_definition_request.py +gooddata_api_client/model/test_llm_provider_definition_request_provider_config.py +gooddata_api_client/model/test_llm_provider_response.py gooddata_api_client/model/test_notification.py gooddata_api_client/model/test_notification_all_of.py gooddata_api_client/model/test_query_duration.py @@ -2382,6 +2498,8 @@ gooddata_api_client/model/total_execution_result_header.py gooddata_api_client/model/total_result_header.py gooddata_api_client/model/trigger_automation_request.py gooddata_api_client/model/trigger_quality_issues_calculation_response.py +gooddata_api_client/model/upsert_knowledge_document_request_dto.py +gooddata_api_client/model/upsert_knowledge_document_response_dto.py gooddata_api_client/model/user_assignee.py gooddata_api_client/model/user_context.py gooddata_api_client/model/user_group_assignee.py @@ -2404,12 +2522,16 @@ gooddata_api_client/model/validate_llm_endpoint_response.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/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_slides_template.py gooddata_api_client/model/workspace_automation_identifier.py gooddata_api_client/model/workspace_automation_management_bulk_request.py diff --git a/gooddata-api-client/.openapi-generator/VERSION b/gooddata-api-client/.openapi-generator/VERSION index 66672d4e9..cd802a1ec 100644 --- a/gooddata-api-client/.openapi-generator/VERSION +++ b/gooddata-api-client/.openapi-generator/VERSION @@ -1 +1 @@ -6.1.0-SNAPSHOT \ No newline at end of file +6.6.0 \ No newline at end of file diff --git a/gooddata-api-client/README.md b/gooddata-api-client/README.md index c7dbd8f08..ed6df0ea5 100644 --- a/gooddata-api-client/README.md +++ b/gooddata-api-client/README.md @@ -5,7 +5,7 @@ This Python package is automatically generated by the [OpenAPI Generator](https: - API version: v0 - Package version: 1.60.0 -- Build package: org.openapitools.codegen.languages.PythonClientCodegen +- Build package: org.openapitools.codegen.languages.PythonPriorClientCodegen ## Requirements. @@ -103,10 +103,13 @@ Class | Method | HTTP request | Description *AIApi* | [**search_entities_memory_items**](docs/AIApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | Search request for MemoryItem *AIApi* | [**update_entity_knowledge_recommendations**](docs/AIApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | *AIApi* | [**update_entity_memory_items**](docs/AIApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | -*AILakeApi* | [**deprovision_ai_lake_database_instance**](docs/AILakeApi.md#deprovision_ai_lake_database_instance) | **DELETE** /api/v1/ailake/database/instance/{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/instance/{instanceId} | (BETA) Get the specified AILake Database instance -*AILakeApi* | [**get_ai_lake_operation**](docs/AILakeApi.md#get_ai_lake_operation) | **GET** /api/v1/ailake/operation/{operationId} | (BETA) Get Long Running Operation details -*AILakeApi* | [**provision_ai_lake_database_instance**](docs/AILakeApi.md#provision_ai_lake_database_instance) | **POST** /api/v1/ailake/database/instance | (BETA) Create a new AILake Database instance +*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* | [**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_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* | [**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 *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 @@ -167,6 +170,7 @@ Class | Method | HTTP request | Description *CSPDirectivesApi* | [**get_entity_csp_directives**](docs/CSPDirectivesApi.md#get_entity_csp_directives) | **GET** /api/v1/entities/cspDirectives/{id} | Get CSP Directives *CSPDirectivesApi* | [**patch_entity_csp_directives**](docs/CSPDirectivesApi.md#patch_entity_csp_directives) | **PATCH** /api/v1/entities/cspDirectives/{id} | Patch CSP Directives *CSPDirectivesApi* | [**update_entity_csp_directives**](docs/CSPDirectivesApi.md#update_entity_csp_directives) | **PUT** /api/v1/entities/cspDirectives/{id} | Put CSP Directives +*CertificationApi* | [**set_certification**](docs/CertificationApi.md#set_certification) | **POST** /api/v1/actions/workspaces/{workspaceId}/setCertification | Set Certification *ComputationApi* | [**cancel_executions**](docs/ComputationApi.md#cancel_executions) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel | Applies all the given cancel tokens. *ComputationApi* | [**change_analysis**](docs/ComputationApi.md#change_analysis) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis | Compute change analysis *ComputationApi* | [**change_analysis_result**](docs/ComputationApi.md#change_analysis_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis/result/{resultId} | Get change analysis result @@ -309,6 +313,12 @@ Class | Method | HTTP request | Description *LLMEndpointsApi* | [**get_entity_llm_endpoints**](docs/LLMEndpointsApi.md#get_entity_llm_endpoints) | **GET** /api/v1/entities/llmEndpoints/{id} | Get LLM endpoint entity *LLMEndpointsApi* | [**patch_entity_llm_endpoints**](docs/LLMEndpointsApi.md#patch_entity_llm_endpoints) | **PATCH** /api/v1/entities/llmEndpoints/{id} | Patch LLM endpoint entity *LLMEndpointsApi* | [**update_entity_llm_endpoints**](docs/LLMEndpointsApi.md#update_entity_llm_endpoints) | **PUT** /api/v1/entities/llmEndpoints/{id} | PUT LLM endpoint entity +*LLMProvidersApi* | [**create_entity_llm_providers**](docs/LLMProvidersApi.md#create_entity_llm_providers) | **POST** /api/v1/entities/llmProviders | Post LLM Provider entities +*LLMProvidersApi* | [**delete_entity_llm_providers**](docs/LLMProvidersApi.md#delete_entity_llm_providers) | **DELETE** /api/v1/entities/llmProviders/{id} | Delete LLM Provider entity +*LLMProvidersApi* | [**get_all_entities_llm_providers**](docs/LLMProvidersApi.md#get_all_entities_llm_providers) | **GET** /api/v1/entities/llmProviders | Get all LLM Provider entities +*LLMProvidersApi* | [**get_entity_llm_providers**](docs/LLMProvidersApi.md#get_entity_llm_providers) | **GET** /api/v1/entities/llmProviders/{id} | Get LLM Provider entity +*LLMProvidersApi* | [**patch_entity_llm_providers**](docs/LLMProvidersApi.md#patch_entity_llm_providers) | **PATCH** /api/v1/entities/llmProviders/{id} | Patch LLM Provider entity +*LLMProvidersApi* | [**update_entity_llm_providers**](docs/LLMProvidersApi.md#update_entity_llm_providers) | **PUT** /api/v1/entities/llmProviders/{id} | PUT LLM Provider entity *LabelsApi* | [**get_all_entities_labels**](docs/LabelsApi.md#get_all_entities_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels | Get all Labels *LabelsApi* | [**get_entity_labels**](docs/LabelsApi.md#get_entity_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Get a Label *LabelsApi* | [**patch_entity_labels**](docs/LabelsApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label (beta) @@ -402,11 +412,15 @@ Class | Method | HTTP request | Description *SmartFunctionsApi* | [**created_by**](docs/SmartFunctionsApi.md#created_by) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy | Get Analytics Catalog CreatedBy Users *SmartFunctionsApi* | [**forecast**](docs/SmartFunctionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | (BETA) Smart functions - Forecast *SmartFunctionsApi* | [**forecast_result**](docs/SmartFunctionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | (BETA) Smart functions - Forecast Result +*SmartFunctionsApi* | [**generate_description**](docs/SmartFunctionsApi.md#generate_description) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateDescription | Generate Description for Analytics Object +*SmartFunctionsApi* | [**generate_title**](docs/SmartFunctionsApi.md#generate_title) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateTitle | Generate Title for Analytics Object *SmartFunctionsApi* | [**get_quality_issues**](docs/SmartFunctionsApi.md#get_quality_issues) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues | Get Quality Issues *SmartFunctionsApi* | [**get_quality_issues_calculation_status**](docs/SmartFunctionsApi.md#get_quality_issues_calculation_status) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId} | Get Quality Issues Calculation Status *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 *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 *SmartFunctionsApi* | [**trigger_quality_issues_calculation**](docs/SmartFunctionsApi.md#trigger_quality_issues_calculation) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck | Trigger Quality Issues Calculation *SmartFunctionsApi* | [**validate_llm_endpoint**](docs/SmartFunctionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/llmEndpoint/test | Validate LLM Endpoint *SmartFunctionsApi* | [**validate_llm_endpoint_by_id**](docs/SmartFunctionsApi.md#validate_llm_endpoint_by_id) | **POST** /api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test | Validate LLM Endpoint By Id @@ -524,6 +538,7 @@ Class | Method | HTTP request | Description *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* | [**create_dashboard_export_request**](docs/ActionsApi.md#create_dashboard_export_request) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular | (EXPERIMENTAL) Create dashboard tabular export request +*ActionsApi* | [**create_document**](docs/ActionsApi.md#create_document) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents | *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 @@ -531,16 +546,20 @@ Class | Method | HTTP request | Description *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 *ActionsApi* | [**dashboard_permissions**](docs/ActionsApi.md#dashboard_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions | Get Dashboard Permissions +*ActionsApi* | [**delete_document**](docs/ActionsApi.md#delete_document) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents/{filename} | *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* | [**explain_afm**](docs/ActionsApi.md#explain_afm) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/explain | AFM explain resource. *ActionsApi* | [**forecast**](docs/ActionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | (BETA) Smart functions - Forecast *ActionsApi* | [**forecast_result**](docs/ActionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | (BETA) Smart functions - Forecast Result +*ActionsApi* | [**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_logical_model_aac**](docs/ActionsApi.md#generate_logical_model_aac) | **POST** /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModelAac | Generate logical data model in AAC format 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 *ActionsApi* | [**get_data_source_schemata**](docs/ActionsApi.md#get_data_source_schemata) | **GET** /api/v1/actions/dataSources/{dataSourceId}/scanSchemata | Get a list of schema names of a database *ActionsApi* | [**get_dependent_entities_graph**](docs/ActionsApi.md#get_dependent_entities_graph) | **GET** /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph | Computes the dependent entities graph *ActionsApi* | [**get_dependent_entities_graph_from_entry_points**](docs/ActionsApi.md#get_dependent_entities_graph_from_entry_points) | **POST** /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph | Computes the dependent entities graph from given entry points +*ActionsApi* | [**get_document**](docs/ActionsApi.md#get_document) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents/{filename} | *ActionsApi* | [**get_exported_file**](docs/ActionsApi.md#get_exported_file) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId} | Retrieve exported files *ActionsApi* | [**get_image_export**](docs/ActionsApi.md#get_image_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/image/{exportId} | (EXPERIMENTAL) Retrieve exported files *ActionsApi* | [**get_image_export_metadata**](docs/ActionsApi.md#get_image_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context @@ -557,6 +576,7 @@ Class | Method | HTTP request | Description *ActionsApi* | [**inherited_entity_prefixes**](docs/ActionsApi.md#inherited_entity_prefixes) | **GET** /api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes | Get used entity prefixes in hierarchy *ActionsApi* | [**key_driver_analysis**](docs/ActionsApi.md#key_driver_analysis) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers | (EXPERIMENTAL) Compute key driver analysis *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* | [**list_documents**](docs/ActionsApi.md#list_documents) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents | *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_dashboard_permissions**](docs/ActionsApi.md#manage_dashboard_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions | Manage Permissions for a Dashboard @@ -573,6 +593,7 @@ Class | Method | HTTP request | Description *ActionsApi* | [**outlier_detection_result**](docs/ActionsApi.md#outlier_detection_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers/result/{resultId} | (BETA) Outlier Detection Result *ActionsApi* | [**overridden_child_entities**](docs/ActionsApi.md#overridden_child_entities) | **GET** /api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities | Finds identifier overrides in workspace hierarchy. *ActionsApi* | [**particular_platform_usage**](docs/ActionsApi.md#particular_platform_usage) | **POST** /api/v1/actions/collectUsage | Info about the platform usage for particular items. +*ActionsApi* | [**patch_document**](docs/ActionsApi.md#patch_document) | **PATCH** /api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents/{filename} | *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* | [**register_upload_notification**](docs/ActionsApi.md#register_upload_notification) | **POST** /api/v1/actions/dataSources/{dataSourceId}/uploadNotification | Register an upload notification @@ -586,12 +607,16 @@ Class | Method | HTTP request | Description *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* | [**search_knowledge**](docs/ActionsApi.md#search_knowledge) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/knowledge/search | +*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* | [**switch_active_identity_provider**](docs/ActionsApi.md#switch_active_identity_provider) | **POST** /api/v1/actions/organization/switchActiveIdentityProvider | Switch Active Identity Provider *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 *ActionsApi* | [**test_existing_notification_channel**](docs/ActionsApi.md#test_existing_notification_channel) | **POST** /api/v1/actions/notificationChannels/{notificationChannelId}/test | Test existing notification channel. +*ActionsApi* | [**test_llm_provider**](docs/ActionsApi.md#test_llm_provider) | **POST** /api/v1/actions/ai/llmProvider/test | Test LLM Provider +*ActionsApi* | [**test_llm_provider_by_id**](docs/ActionsApi.md#test_llm_provider_by_id) | **POST** /api/v1/actions/ai/llmProvider/{llmProviderId}/test | Test LLM Provider By Id *ActionsApi* | [**test_notification_channel**](docs/ActionsApi.md#test_notification_channel) | **POST** /api/v1/actions/notificationChannels/test | Test notification channel. *ActionsApi* | [**trigger_automation**](docs/ActionsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation. *ActionsApi* | [**trigger_existing_automation**](docs/ActionsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation. @@ -603,6 +628,7 @@ Class | Method | HTTP request | Description *ActionsApi* | [**unsubscribe_organization_automations**](docs/ActionsApi.md#unsubscribe_organization_automations) | **POST** /api/v1/actions/organization/automations/unsubscribe | Unsubscribe from selected automations across all workspaces *ActionsApi* | [**unsubscribe_selected_workspace_automations**](docs/ActionsApi.md#unsubscribe_selected_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from selected automations in the workspace *ActionsApi* | [**unsubscribe_workspace_automations**](docs/ActionsApi.md#unsubscribe_workspace_automations) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from all automations in the workspace +*ActionsApi* | [**upsert_document**](docs/ActionsApi.md#upsert_document) | **PUT** /api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents | *ActionsApi* | [**validate_llm_endpoint**](docs/ActionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/llmEndpoint/test | Validate LLM Endpoint *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 *ActionsApi* | [**workspace_resolve_all_settings**](docs/ActionsApi.md#workspace_resolve_all_settings) | **GET** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for all settings. @@ -626,6 +652,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**create_entity_jwks**](docs/EntitiesApi.md#create_entity_jwks) | **POST** /api/v1/entities/jwks | Post Jwks *EntitiesApi* | [**create_entity_knowledge_recommendations**](docs/EntitiesApi.md#create_entity_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | *EntitiesApi* | [**create_entity_llm_endpoints**](docs/EntitiesApi.md#create_entity_llm_endpoints) | **POST** /api/v1/entities/llmEndpoints | Post LLM endpoint entities +*EntitiesApi* | [**create_entity_llm_providers**](docs/EntitiesApi.md#create_entity_llm_providers) | **POST** /api/v1/entities/llmProviders | Post LLM Provider entities *EntitiesApi* | [**create_entity_memory_items**](docs/EntitiesApi.md#create_entity_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems | *EntitiesApi* | [**create_entity_metrics**](docs/EntitiesApi.md#create_entity_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics | Post Metrics *EntitiesApi* | [**create_entity_notification_channels**](docs/EntitiesApi.md#create_entity_notification_channels) | **POST** /api/v1/entities/notificationChannels | Post Notification Channel entities @@ -658,6 +685,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**delete_entity_jwks**](docs/EntitiesApi.md#delete_entity_jwks) | **DELETE** /api/v1/entities/jwks/{id} | Delete Jwk *EntitiesApi* | [**delete_entity_knowledge_recommendations**](docs/EntitiesApi.md#delete_entity_knowledge_recommendations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | *EntitiesApi* | [**delete_entity_llm_endpoints**](docs/EntitiesApi.md#delete_entity_llm_endpoints) | **DELETE** /api/v1/entities/llmEndpoints/{id} | +*EntitiesApi* | [**delete_entity_llm_providers**](docs/EntitiesApi.md#delete_entity_llm_providers) | **DELETE** /api/v1/entities/llmProviders/{id} | Delete LLM Provider entity *EntitiesApi* | [**delete_entity_memory_items**](docs/EntitiesApi.md#delete_entity_memory_items) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | *EntitiesApi* | [**delete_entity_metrics**](docs/EntitiesApi.md#delete_entity_metrics) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Delete a Metric *EntitiesApi* | [**delete_entity_notification_channels**](docs/EntitiesApi.md#delete_entity_notification_channels) | **DELETE** /api/v1/entities/notificationChannels/{id} | Delete Notification Channel entity @@ -698,6 +726,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_all_entities_knowledge_recommendations**](docs/EntitiesApi.md#get_all_entities_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | *EntitiesApi* | [**get_all_entities_labels**](docs/EntitiesApi.md#get_all_entities_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels | Get all Labels *EntitiesApi* | [**get_all_entities_llm_endpoints**](docs/EntitiesApi.md#get_all_entities_llm_endpoints) | **GET** /api/v1/entities/llmEndpoints | Get all LLM endpoint entities +*EntitiesApi* | [**get_all_entities_llm_providers**](docs/EntitiesApi.md#get_all_entities_llm_providers) | **GET** /api/v1/entities/llmProviders | Get all LLM Provider entities *EntitiesApi* | [**get_all_entities_memory_items**](docs/EntitiesApi.md#get_all_entities_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems | *EntitiesApi* | [**get_all_entities_metrics**](docs/EntitiesApi.md#get_all_entities_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics | Get all Metrics *EntitiesApi* | [**get_all_entities_notification_channel_identifiers**](docs/EntitiesApi.md#get_all_entities_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers | @@ -742,6 +771,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_entity_knowledge_recommendations**](docs/EntitiesApi.md#get_entity_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | *EntitiesApi* | [**get_entity_labels**](docs/EntitiesApi.md#get_entity_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Get a Label *EntitiesApi* | [**get_entity_llm_endpoints**](docs/EntitiesApi.md#get_entity_llm_endpoints) | **GET** /api/v1/entities/llmEndpoints/{id} | Get LLM endpoint entity +*EntitiesApi* | [**get_entity_llm_providers**](docs/EntitiesApi.md#get_entity_llm_providers) | **GET** /api/v1/entities/llmProviders/{id} | Get LLM Provider entity *EntitiesApi* | [**get_entity_memory_items**](docs/EntitiesApi.md#get_entity_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | *EntitiesApi* | [**get_entity_metrics**](docs/EntitiesApi.md#get_entity_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Get a Metric *EntitiesApi* | [**get_entity_notification_channel_identifiers**](docs/EntitiesApi.md#get_entity_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers/{id} | @@ -782,6 +812,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**patch_entity_knowledge_recommendations**](docs/EntitiesApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | *EntitiesApi* | [**patch_entity_labels**](docs/EntitiesApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label (beta) *EntitiesApi* | [**patch_entity_llm_endpoints**](docs/EntitiesApi.md#patch_entity_llm_endpoints) | **PATCH** /api/v1/entities/llmEndpoints/{id} | Patch LLM endpoint entity +*EntitiesApi* | [**patch_entity_llm_providers**](docs/EntitiesApi.md#patch_entity_llm_providers) | **PATCH** /api/v1/entities/llmProviders/{id} | Patch LLM Provider entity *EntitiesApi* | [**patch_entity_memory_items**](docs/EntitiesApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | *EntitiesApi* | [**patch_entity_metrics**](docs/EntitiesApi.md#patch_entity_metrics) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Patch a Metric *EntitiesApi* | [**patch_entity_notification_channels**](docs/EntitiesApi.md#patch_entity_notification_channels) | **PATCH** /api/v1/entities/notificationChannels/{id} | Patch Notification Channel entity @@ -836,6 +867,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**update_entity_jwks**](docs/EntitiesApi.md#update_entity_jwks) | **PUT** /api/v1/entities/jwks/{id} | Put Jwk *EntitiesApi* | [**update_entity_knowledge_recommendations**](docs/EntitiesApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | *EntitiesApi* | [**update_entity_llm_endpoints**](docs/EntitiesApi.md#update_entity_llm_endpoints) | **PUT** /api/v1/entities/llmEndpoints/{id} | PUT LLM endpoint entity +*EntitiesApi* | [**update_entity_llm_providers**](docs/EntitiesApi.md#update_entity_llm_providers) | **PUT** /api/v1/entities/llmProviders/{id} | PUT LLM Provider entity *EntitiesApi* | [**update_entity_memory_items**](docs/EntitiesApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | *EntitiesApi* | [**update_entity_metrics**](docs/EntitiesApi.md#update_entity_metrics) | **PUT** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Put a Metric *EntitiesApi* | [**update_entity_notification_channels**](docs/EntitiesApi.md#update_entity_notification_channels) | **PUT** /api/v1/entities/notificationChannels/{id} | Put Notification Channel entity @@ -909,6 +941,7 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**create_entity_identity_providers**](docs/OrganizationModelControllerApi.md#create_entity_identity_providers) | **POST** /api/v1/entities/identityProviders | Post Identity Providers *OrganizationModelControllerApi* | [**create_entity_jwks**](docs/OrganizationModelControllerApi.md#create_entity_jwks) | **POST** /api/v1/entities/jwks | Post Jwks *OrganizationModelControllerApi* | [**create_entity_llm_endpoints**](docs/OrganizationModelControllerApi.md#create_entity_llm_endpoints) | **POST** /api/v1/entities/llmEndpoints | Post LLM endpoint entities +*OrganizationModelControllerApi* | [**create_entity_llm_providers**](docs/OrganizationModelControllerApi.md#create_entity_llm_providers) | **POST** /api/v1/entities/llmProviders | Post LLM Provider entities *OrganizationModelControllerApi* | [**create_entity_notification_channels**](docs/OrganizationModelControllerApi.md#create_entity_notification_channels) | **POST** /api/v1/entities/notificationChannels | Post Notification Channel entities *OrganizationModelControllerApi* | [**create_entity_organization_settings**](docs/OrganizationModelControllerApi.md#create_entity_organization_settings) | **POST** /api/v1/entities/organizationSettings | Post Organization Setting entities *OrganizationModelControllerApi* | [**create_entity_themes**](docs/OrganizationModelControllerApi.md#create_entity_themes) | **POST** /api/v1/entities/themes | Post Theming @@ -923,6 +956,7 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**delete_entity_identity_providers**](docs/OrganizationModelControllerApi.md#delete_entity_identity_providers) | **DELETE** /api/v1/entities/identityProviders/{id} | Delete Identity Provider *OrganizationModelControllerApi* | [**delete_entity_jwks**](docs/OrganizationModelControllerApi.md#delete_entity_jwks) | **DELETE** /api/v1/entities/jwks/{id} | Delete Jwk *OrganizationModelControllerApi* | [**delete_entity_llm_endpoints**](docs/OrganizationModelControllerApi.md#delete_entity_llm_endpoints) | **DELETE** /api/v1/entities/llmEndpoints/{id} | +*OrganizationModelControllerApi* | [**delete_entity_llm_providers**](docs/OrganizationModelControllerApi.md#delete_entity_llm_providers) | **DELETE** /api/v1/entities/llmProviders/{id} | Delete LLM Provider entity *OrganizationModelControllerApi* | [**delete_entity_notification_channels**](docs/OrganizationModelControllerApi.md#delete_entity_notification_channels) | **DELETE** /api/v1/entities/notificationChannels/{id} | Delete Notification Channel entity *OrganizationModelControllerApi* | [**delete_entity_organization_settings**](docs/OrganizationModelControllerApi.md#delete_entity_organization_settings) | **DELETE** /api/v1/entities/organizationSettings/{id} | Delete Organization entity *OrganizationModelControllerApi* | [**delete_entity_themes**](docs/OrganizationModelControllerApi.md#delete_entity_themes) | **DELETE** /api/v1/entities/themes/{id} | Delete Theming @@ -939,6 +973,7 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**get_all_entities_identity_providers**](docs/OrganizationModelControllerApi.md#get_all_entities_identity_providers) | **GET** /api/v1/entities/identityProviders | Get all Identity Providers *OrganizationModelControllerApi* | [**get_all_entities_jwks**](docs/OrganizationModelControllerApi.md#get_all_entities_jwks) | **GET** /api/v1/entities/jwks | Get all Jwks *OrganizationModelControllerApi* | [**get_all_entities_llm_endpoints**](docs/OrganizationModelControllerApi.md#get_all_entities_llm_endpoints) | **GET** /api/v1/entities/llmEndpoints | Get all LLM endpoint entities +*OrganizationModelControllerApi* | [**get_all_entities_llm_providers**](docs/OrganizationModelControllerApi.md#get_all_entities_llm_providers) | **GET** /api/v1/entities/llmProviders | Get all LLM Provider entities *OrganizationModelControllerApi* | [**get_all_entities_notification_channel_identifiers**](docs/OrganizationModelControllerApi.md#get_all_entities_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers | *OrganizationModelControllerApi* | [**get_all_entities_notification_channels**](docs/OrganizationModelControllerApi.md#get_all_entities_notification_channels) | **GET** /api/v1/entities/notificationChannels | Get all Notification Channel entities *OrganizationModelControllerApi* | [**get_all_entities_organization_settings**](docs/OrganizationModelControllerApi.md#get_all_entities_organization_settings) | **GET** /api/v1/entities/organizationSettings | Get Organization entities @@ -957,6 +992,7 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**get_entity_identity_providers**](docs/OrganizationModelControllerApi.md#get_entity_identity_providers) | **GET** /api/v1/entities/identityProviders/{id} | Get Identity Provider *OrganizationModelControllerApi* | [**get_entity_jwks**](docs/OrganizationModelControllerApi.md#get_entity_jwks) | **GET** /api/v1/entities/jwks/{id} | Get Jwk *OrganizationModelControllerApi* | [**get_entity_llm_endpoints**](docs/OrganizationModelControllerApi.md#get_entity_llm_endpoints) | **GET** /api/v1/entities/llmEndpoints/{id} | Get LLM endpoint entity +*OrganizationModelControllerApi* | [**get_entity_llm_providers**](docs/OrganizationModelControllerApi.md#get_entity_llm_providers) | **GET** /api/v1/entities/llmProviders/{id} | Get LLM Provider entity *OrganizationModelControllerApi* | [**get_entity_notification_channel_identifiers**](docs/OrganizationModelControllerApi.md#get_entity_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers/{id} | *OrganizationModelControllerApi* | [**get_entity_notification_channels**](docs/OrganizationModelControllerApi.md#get_entity_notification_channels) | **GET** /api/v1/entities/notificationChannels/{id} | Get Notification Channel entity *OrganizationModelControllerApi* | [**get_entity_organization_settings**](docs/OrganizationModelControllerApi.md#get_entity_organization_settings) | **GET** /api/v1/entities/organizationSettings/{id} | Get Organization entity @@ -973,6 +1009,7 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**patch_entity_identity_providers**](docs/OrganizationModelControllerApi.md#patch_entity_identity_providers) | **PATCH** /api/v1/entities/identityProviders/{id} | Patch Identity Provider *OrganizationModelControllerApi* | [**patch_entity_jwks**](docs/OrganizationModelControllerApi.md#patch_entity_jwks) | **PATCH** /api/v1/entities/jwks/{id} | Patch Jwk *OrganizationModelControllerApi* | [**patch_entity_llm_endpoints**](docs/OrganizationModelControllerApi.md#patch_entity_llm_endpoints) | **PATCH** /api/v1/entities/llmEndpoints/{id} | Patch LLM endpoint entity +*OrganizationModelControllerApi* | [**patch_entity_llm_providers**](docs/OrganizationModelControllerApi.md#patch_entity_llm_providers) | **PATCH** /api/v1/entities/llmProviders/{id} | Patch LLM Provider entity *OrganizationModelControllerApi* | [**patch_entity_notification_channels**](docs/OrganizationModelControllerApi.md#patch_entity_notification_channels) | **PATCH** /api/v1/entities/notificationChannels/{id} | Patch Notification Channel entity *OrganizationModelControllerApi* | [**patch_entity_organization_settings**](docs/OrganizationModelControllerApi.md#patch_entity_organization_settings) | **PATCH** /api/v1/entities/organizationSettings/{id} | Patch Organization entity *OrganizationModelControllerApi* | [**patch_entity_themes**](docs/OrganizationModelControllerApi.md#patch_entity_themes) | **PATCH** /api/v1/entities/themes/{id} | Patch Theming @@ -987,6 +1024,7 @@ Class | Method | HTTP request | Description *OrganizationModelControllerApi* | [**update_entity_identity_providers**](docs/OrganizationModelControllerApi.md#update_entity_identity_providers) | **PUT** /api/v1/entities/identityProviders/{id} | Put Identity Provider *OrganizationModelControllerApi* | [**update_entity_jwks**](docs/OrganizationModelControllerApi.md#update_entity_jwks) | **PUT** /api/v1/entities/jwks/{id} | Put Jwk *OrganizationModelControllerApi* | [**update_entity_llm_endpoints**](docs/OrganizationModelControllerApi.md#update_entity_llm_endpoints) | **PUT** /api/v1/entities/llmEndpoints/{id} | PUT LLM endpoint entity +*OrganizationModelControllerApi* | [**update_entity_llm_providers**](docs/OrganizationModelControllerApi.md#update_entity_llm_providers) | **PUT** /api/v1/entities/llmProviders/{id} | PUT LLM Provider entity *OrganizationModelControllerApi* | [**update_entity_notification_channels**](docs/OrganizationModelControllerApi.md#update_entity_notification_channels) | **PUT** /api/v1/entities/notificationChannels/{id} | Put Notification Channel entity *OrganizationModelControllerApi* | [**update_entity_organization_settings**](docs/OrganizationModelControllerApi.md#update_entity_organization_settings) | **PUT** /api/v1/entities/organizationSettings/{id} | Put Organization entity *OrganizationModelControllerApi* | [**update_entity_themes**](docs/OrganizationModelControllerApi.md#update_entity_themes) | **PUT** /api/v1/entities/themes/{id} | Put Theming @@ -1215,11 +1253,14 @@ Class | Method | HTTP request | Description - [AlertConditionOperand](docs/AlertConditionOperand.md) - [AlertDescription](docs/AlertDescription.md) - [AlertEvaluationRow](docs/AlertEvaluationRow.md) + - [AllTimeDateFilter](docs/AllTimeDateFilter.md) + - [AllTimeDateFilterAllTimeDateFilter](docs/AllTimeDateFilterAllTimeDateFilter.md) - [AllowedRelationshipType](docs/AllowedRelationshipType.md) - [AnalyticsCatalogCreatedBy](docs/AnalyticsCatalogCreatedBy.md) - [AnalyticsCatalogTags](docs/AnalyticsCatalogTags.md) - [AnalyticsCatalogUser](docs/AnalyticsCatalogUser.md) - [AnomalyDetection](docs/AnomalyDetection.md) + - [AnomalyDetectionConfig](docs/AnomalyDetectionConfig.md) - [AnomalyDetectionRequest](docs/AnomalyDetectionRequest.md) - [AnomalyDetectionResult](docs/AnomalyDetectionResult.md) - [AnomalyDetectionWrapper](docs/AnomalyDetectionWrapper.md) @@ -1261,6 +1302,14 @@ Class | Method | HTTP request | Description - [AutomationTabularExport](docs/AutomationTabularExport.md) - [AutomationVisualExport](docs/AutomationVisualExport.md) - [AvailableAssignees](docs/AvailableAssignees.md) + - [AwsBedrockAccessKeyAuth](docs/AwsBedrockAccessKeyAuth.md) + - [AwsBedrockAccessKeyAuthAllOf](docs/AwsBedrockAccessKeyAuthAllOf.md) + - [AwsBedrockProviderConfig](docs/AwsBedrockProviderConfig.md) + - [AzureFoundryApiKeyAuth](docs/AzureFoundryApiKeyAuth.md) + - [AzureFoundryApiKeyAuthAllOf](docs/AzureFoundryApiKeyAuthAllOf.md) + - [AzureFoundryProviderAuth](docs/AzureFoundryProviderAuth.md) + - [AzureFoundryProviderConfig](docs/AzureFoundryProviderConfig.md) + - [BedrockProviderAuth](docs/BedrockProviderAuth.md) - [BoundedFilter](docs/BoundedFilter.md) - [ChangeAnalysisParams](docs/ChangeAnalysisParams.md) - [ChangeAnalysisParamsFiltersInner](docs/ChangeAnalysisParamsFiltersInner.md) @@ -1273,6 +1322,7 @@ Class | Method | HTTP request | Description - [ChatRequest](docs/ChatRequest.md) - [ChatResult](docs/ChatResult.md) - [ChatUsageResponse](docs/ChatUsageResponse.md) + - [ClusteringConfig](docs/ClusteringConfig.md) - [ClusteringRequest](docs/ClusteringRequest.md) - [ClusteringResult](docs/ClusteringResult.md) - [ColumnLocation](docs/ColumnLocation.md) @@ -1293,6 +1343,8 @@ Class | Method | HTTP request | Description - [CompoundMeasureValueFilterCompoundMeasureValueFilter](docs/CompoundMeasureValueFilterCompoundMeasureValueFilter.md) - [ContentSlideTemplate](docs/ContentSlideTemplate.md) - [CoverSlideTemplate](docs/CoverSlideTemplate.md) + - [CreateKnowledgeDocumentRequestDto](docs/CreateKnowledgeDocumentRequestDto.md) + - [CreateKnowledgeDocumentResponseDto](docs/CreateKnowledgeDocumentResponseDto.md) - [CreatedVisualization](docs/CreatedVisualization.md) - [CreatedVisualizationFiltersInner](docs/CreatedVisualizationFiltersInner.md) - [CreatedVisualizations](docs/CreatedVisualizations.md) @@ -1416,6 +1468,7 @@ Class | Method | HTTP request | Description - [DeclarativeWorkspaces](docs/DeclarativeWorkspaces.md) - [DefaultSmtp](docs/DefaultSmtp.md) - [DefaultSmtpAllOf](docs/DefaultSmtpAllOf.md) + - [DeleteKnowledgeDocumentResponseDto](docs/DeleteKnowledgeDocumentResponseDto.md) - [DependentEntitiesGraph](docs/DependentEntitiesGraph.md) - [DependentEntitiesNode](docs/DependentEntitiesNode.md) - [DependentEntitiesRequest](docs/DependentEntitiesRequest.md) @@ -1457,13 +1510,18 @@ Class | Method | HTTP request | Description - [FilterBy](docs/FilterBy.md) - [FilterDefinition](docs/FilterDefinition.md) - [FilterDefinitionForSimpleMeasure](docs/FilterDefinitionForSimpleMeasure.md) + - [ForecastConfig](docs/ForecastConfig.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) + - [GenerateDescriptionRequest](docs/GenerateDescriptionRequest.md) + - [GenerateDescriptionResponse](docs/GenerateDescriptionResponse.md) - [GenerateLdmRequest](docs/GenerateLdmRequest.md) + - [GenerateTitleRequest](docs/GenerateTitleRequest.md) + - [GenerateTitleResponse](docs/GenerateTitleResponse.md) - [GeoAreaConfig](docs/GeoAreaConfig.md) - [GeoCollectionIdentifier](docs/GeoCollectionIdentifier.md) - [GetAiLakeOperation200Response](docs/GetAiLakeOperation200Response.md) @@ -1515,7 +1573,7 @@ Class | Method | HTTP request | Description - [JsonApiAnalyticalDashboardOutMetaAccessInfo](docs/JsonApiAnalyticalDashboardOutMetaAccessInfo.md) - [JsonApiAnalyticalDashboardOutRelationships](docs/JsonApiAnalyticalDashboardOutRelationships.md) - [JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards](docs/JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards.md) - - [JsonApiAnalyticalDashboardOutRelationshipsCreatedBy](docs/JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) + - [JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy](docs/JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md) - [JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins](docs/JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins.md) - [JsonApiAnalyticalDashboardOutRelationshipsDatasets](docs/JsonApiAnalyticalDashboardOutRelationshipsDatasets.md) - [JsonApiAnalyticalDashboardOutRelationshipsFilterContexts](docs/JsonApiAnalyticalDashboardOutRelationshipsFilterContexts.md) @@ -1849,6 +1907,18 @@ Class | Method | HTTP request | Description - [JsonApiLlmEndpointPatch](docs/JsonApiLlmEndpointPatch.md) - [JsonApiLlmEndpointPatchAttributes](docs/JsonApiLlmEndpointPatchAttributes.md) - [JsonApiLlmEndpointPatchDocument](docs/JsonApiLlmEndpointPatchDocument.md) + - [JsonApiLlmProviderIn](docs/JsonApiLlmProviderIn.md) + - [JsonApiLlmProviderInAttributes](docs/JsonApiLlmProviderInAttributes.md) + - [JsonApiLlmProviderInAttributesModelsInner](docs/JsonApiLlmProviderInAttributesModelsInner.md) + - [JsonApiLlmProviderInAttributesProviderConfig](docs/JsonApiLlmProviderInAttributesProviderConfig.md) + - [JsonApiLlmProviderInDocument](docs/JsonApiLlmProviderInDocument.md) + - [JsonApiLlmProviderOut](docs/JsonApiLlmProviderOut.md) + - [JsonApiLlmProviderOutDocument](docs/JsonApiLlmProviderOutDocument.md) + - [JsonApiLlmProviderOutList](docs/JsonApiLlmProviderOutList.md) + - [JsonApiLlmProviderOutWithLinks](docs/JsonApiLlmProviderOutWithLinks.md) + - [JsonApiLlmProviderPatch](docs/JsonApiLlmProviderPatch.md) + - [JsonApiLlmProviderPatchAttributes](docs/JsonApiLlmProviderPatchAttributes.md) + - [JsonApiLlmProviderPatchDocument](docs/JsonApiLlmProviderPatchDocument.md) - [JsonApiMemoryItemIn](docs/JsonApiMemoryItemIn.md) - [JsonApiMemoryItemInAttributes](docs/JsonApiMemoryItemInAttributes.md) - [JsonApiMemoryItemInDocument](docs/JsonApiMemoryItemInDocument.md) @@ -2070,9 +2140,15 @@ Class | Method | HTTP request | Description - [KeyDriversRequest](docs/KeyDriversRequest.md) - [KeyDriversResponse](docs/KeyDriversResponse.md) - [KeyDriversResult](docs/KeyDriversResult.md) + - [KnowledgeDocumentMetadataDto](docs/KnowledgeDocumentMetadataDto.md) + - [KnowledgeSearchResultDto](docs/KnowledgeSearchResultDto.md) - [LabelIdentifier](docs/LabelIdentifier.md) + - [ListKnowledgeDocumentsResponseDto](docs/ListKnowledgeDocumentsResponseDto.md) - [ListLinks](docs/ListLinks.md) - [ListLinksAllOf](docs/ListLinksAllOf.md) + - [LlmModel](docs/LlmModel.md) + - [LlmProviderAuth](docs/LlmProviderAuth.md) + - [LlmProviderConfig](docs/LlmProviderConfig.md) - [LocalIdentifier](docs/LocalIdentifier.md) - [LocaleRequest](docs/LocaleRequest.md) - [ManageDashboardPermissionsRequestInner](docs/ManageDashboardPermissionsRequestInner.md) @@ -2090,8 +2166,10 @@ Class | Method | HTTP request | Description - [MemoryItemCreatedByUsers](docs/MemoryItemCreatedByUsers.md) - [MemoryItemUser](docs/MemoryItemUser.md) - [Metric](docs/Metric.md) + - [MetricDefinitionOverride](docs/MetricDefinitionOverride.md) - [MetricRecord](docs/MetricRecord.md) - [MetricValueChange](docs/MetricValueChange.md) + - [ModelTestResult](docs/ModelTestResult.md) - [NegativeAttributeFilter](docs/NegativeAttributeFilter.md) - [NegativeAttributeFilterNegativeAttributeFilter](docs/NegativeAttributeFilterNegativeAttributeFilter.md) - [Note](docs/Note.md) @@ -2106,6 +2184,10 @@ Class | Method | HTTP request | Description - [NotificationsMetaTotal](docs/NotificationsMetaTotal.md) - [ObjectLinks](docs/ObjectLinks.md) - [ObjectLinksContainer](docs/ObjectLinksContainer.md) + - [OpenAIProviderConfig](docs/OpenAIProviderConfig.md) + - [OpenAiApiKeyAuth](docs/OpenAiApiKeyAuth.md) + - [OpenAiApiKeyAuthAllOf](docs/OpenAiApiKeyAuthAllOf.md) + - [OpenAiProviderAuth](docs/OpenAiProviderAuth.md) - [Operation](docs/Operation.md) - [OperationError](docs/OperationError.md) - [OrganizationAutomationIdentifier](docs/OrganizationAutomationIdentifier.md) @@ -2118,6 +2200,7 @@ Class | Method | HTTP request | Description - [PageMetadata](docs/PageMetadata.md) - [Paging](docs/Paging.md) - [Parameter](docs/Parameter.md) + - [PatchKnowledgeDocumentRequestDto](docs/PatchKnowledgeDocumentRequestDto.md) - [PdfTableStyle](docs/PdfTableStyle.md) - [PdfTableStyleProperty](docs/PdfTableStyleProperty.md) - [PdmLdmRequest](docs/PdmLdmRequest.md) @@ -2176,17 +2259,22 @@ Class | Method | HTTP request | Description - [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) + - [SearchKnowledgeResponseDto](docs/SearchKnowledgeResponseDto.md) - [SearchRelationshipObject](docs/SearchRelationshipObject.md) - [SearchRequest](docs/SearchRequest.md) - [SearchResult](docs/SearchResult.md) - [SearchResultObject](docs/SearchResultObject.md) + - [SearchStatisticsDto](docs/SearchStatisticsDto.md) - [SectionSlideTemplate](docs/SectionSlideTemplate.md) + - [ServiceInfo](docs/ServiceInfo.md) + - [SetCertificationRequest](docs/SetCertificationRequest.md) - [Settings](docs/Settings.md) - [SimpleMeasureDefinition](docs/SimpleMeasureDefinition.md) - [SimpleMeasureDefinitionMeasure](docs/SimpleMeasureDefinitionMeasure.md) @@ -2216,6 +2304,9 @@ Class | Method | HTTP request | Description - [TabularExportRequest](docs/TabularExportRequest.md) - [TestDefinitionRequest](docs/TestDefinitionRequest.md) - [TestDestinationRequest](docs/TestDestinationRequest.md) + - [TestLlmProviderDefinitionRequest](docs/TestLlmProviderDefinitionRequest.md) + - [TestLlmProviderDefinitionRequestProviderConfig](docs/TestLlmProviderDefinitionRequestProviderConfig.md) + - [TestLlmProviderResponse](docs/TestLlmProviderResponse.md) - [TestNotification](docs/TestNotification.md) - [TestNotificationAllOf](docs/TestNotificationAllOf.md) - [TestQueryDuration](docs/TestQueryDuration.md) @@ -2228,6 +2319,8 @@ Class | Method | HTTP request | Description - [TotalResultHeader](docs/TotalResultHeader.md) - [TriggerAutomationRequest](docs/TriggerAutomationRequest.md) - [TriggerQualityIssuesCalculationResponse](docs/TriggerQualityIssuesCalculationResponse.md) + - [UpsertKnowledgeDocumentRequestDto](docs/UpsertKnowledgeDocumentRequestDto.md) + - [UpsertKnowledgeDocumentResponseDto](docs/UpsertKnowledgeDocumentResponseDto.md) - [UserAssignee](docs/UserAssignee.md) - [UserContext](docs/UserContext.md) - [UserGroupAssignee](docs/UserGroupAssignee.md) @@ -2250,12 +2343,16 @@ Class | Method | HTTP request | Description - [Value](docs/Value.md) - [VisibleFilter](docs/VisibleFilter.md) - [VisualExportRequest](docs/VisualExportRequest.md) + - [VisualizationConfig](docs/VisualizationConfig.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) - [WidgetSlidesTemplate](docs/WidgetSlidesTemplate.md) - [WorkspaceAutomationIdentifier](docs/WorkspaceAutomationIdentifier.md) - [WorkspaceAutomationManagementBulkRequest](docs/WorkspaceAutomationManagementBulkRequest.md) @@ -2269,9 +2366,11 @@ Class | Method | HTTP request | Description - [Xliff](docs/Xliff.md) + ## Documentation For Authorization - All endpoints do not require authorization. +Endpoints do not require authorization. + ## Author diff --git a/gooddata-api-client/docs/AFM.md b/gooddata-api-client/docs/AFM.md index f0e919ef5..1876a4cc4 100644 --- a/gooddata-api-client/docs/AFM.md +++ b/gooddata-api-client/docs/AFM.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **filters** | [**[AFMFiltersInner]**](AFMFiltersInner.md) | Various filter types to filter the execution result. | **measures** | [**[MeasureItem]**](MeasureItem.md) | Metrics to be computed. | **aux_measures** | [**[MeasureItem]**](MeasureItem.md) | Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result. | [optional] +**measure_definition_overrides** | [**[MetricDefinitionOverride]**](MetricDefinitionOverride.md) | (EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric's MAQL definition without modifying the stored definition. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AFMFiltersInner.md b/gooddata-api-client/docs/AFMFiltersInner.md index 3f5b2c615..c8ff00a9a 100644 --- a/gooddata-api-client/docs/AFMFiltersInner.md +++ b/gooddata-api-client/docs/AFMFiltersInner.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **ranking_filter** | [**RankingFilterRankingFilter**](RankingFilterRankingFilter.md) | | [optional] **absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] **relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | [optional] +**all_time_date_filter** | [**AllTimeDateFilterAllTimeDateFilter**](AllTimeDateFilterAllTimeDateFilter.md) | | [optional] **negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | [optional] **positive_attribute_filter** | [**PositiveAttributeFilterPositiveAttributeFilter**](PositiveAttributeFilterPositiveAttributeFilter.md) | | [optional] **match_attribute_filter** | [**MatchAttributeFilterMatchAttributeFilter**](MatchAttributeFilterMatchAttributeFilter.md) | | [optional] diff --git a/gooddata-api-client/docs/AILakeApi.md b/gooddata-api-client/docs/AILakeApi.md index 82ff0fa26..4b6c713fc 100644 --- a/gooddata-api-client/docs/AILakeApi.md +++ b/gooddata-api-client/docs/AILakeApi.md @@ -4,10 +4,13 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**deprovision_ai_lake_database_instance**](AILakeApi.md#deprovision_ai_lake_database_instance) | **DELETE** /api/v1/ailake/database/instance/{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/instance/{instanceId} | (BETA) Get the specified AILake Database instance -[**get_ai_lake_operation**](AILakeApi.md#get_ai_lake_operation) | **GET** /api/v1/ailake/operation/{operationId} | (BETA) Get Long Running Operation details -[**provision_ai_lake_database_instance**](AILakeApi.md#provision_ai_lake_database_instance) | **POST** /api/v1/ailake/database/instance | (BETA) Create a new AILake Database instance +[**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 +[**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_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 +[**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 # **deprovision_ai_lake_database_instance** @@ -221,6 +224,132 @@ No authorization required [[Back to top]](#) [[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_database_instances** +> [DatabaseInstance] list_ai_lake_database_instances() + +(BETA) List AI Lake Database instances + +(BETA) Lists database instances in the organization's AI Lake. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import ai_lake_api +from gooddata_api_client.model.database_instance import DatabaseInstance +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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) + + # example, this endpoint has no required or optional parameters + try: + # (BETA) List AI Lake Database instances + api_response = api_instance.list_ai_lake_database_instances() + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->list_ai_lake_database_instances: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**[DatabaseInstance]**](DatabaseInstance.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 database instances 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** +> [ServiceInfo] list_ai_lake_services() + +(BETA) List AI Lake services + +(BETA) Lists services configured for the organization's AI Lake. Returns only non-sensitive fields (id, name). + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import ai_lake_api +from gooddata_api_client.model.service_info import ServiceInfo +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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) + + # example, this endpoint has no required or optional parameters + try: + # (BETA) List AI Lake services + api_response = api_instance.list_ai_lake_services() + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->list_ai_lake_services: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**[ServiceInfo]**](ServiceInfo.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 services 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) + # **provision_ai_lake_database_instance** > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} provision_ai_lake_database_instance(provision_database_instance_request) @@ -304,3 +433,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) +# **run_ai_lake_service_command** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} run_ai_lake_service_command(service_id, command_name, run_service_command_request) + +(BETA) Run an AI Lake services command + +(BETA) Runs a specific AI Lake service command. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import ai_lake_api +from gooddata_api_client.model.run_service_command_request import RunServiceCommandRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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) + service_id = "serviceId_example" # str | + command_name = "commandName_example" # str | + run_service_command_request = RunServiceCommandRequest( + context={ + "key": "key_example", + }, + payload=JsonNode(), + ) # RunServiceCommandRequest | + operation_id = "operation-id_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + # (BETA) Run an AI Lake services command + api_response = api_instance.run_ai_lake_service_command(service_id, command_name, run_service_command_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->run_ai_lake_service_command: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (BETA) Run an AI Lake services command + api_response = api_instance.run_ai_lake_service_command(service_id, command_name, run_service_command_request, operation_id=operation_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->run_ai_lake_service_command: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| | + **command_name** | **str**| | + **run_service_command_request** | [**RunServiceCommandRequest**](RunServiceCommandRequest.md)| | + **operation_id** | **str**| | [optional] + +### Return type + +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### 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/AbsoluteDateFilterAbsoluteDateFilter.md b/gooddata-api-client/docs/AbsoluteDateFilterAbsoluteDateFilter.md index a82af8ee5..a8cb9af60 100644 --- a/gooddata-api-client/docs/AbsoluteDateFilterAbsoluteDateFilter.md +++ b/gooddata-api-client/docs/AbsoluteDateFilterAbsoluteDateFilter.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **_from** | **str** | | **to** | **str** | | **apply_on_result** | **bool** | | [optional] +**empty_value_handling** | **str** | Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates. | [optional] if omitted the server will use the default value of "EXCLUDE" **local_identifier** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/ActionsApi.md b/gooddata-api-client/docs/ActionsApi.md index b192509db..00977d702 100644 --- a/gooddata-api-client/docs/ActionsApi.md +++ b/gooddata-api-client/docs/ActionsApi.md @@ -26,6 +26,7 @@ Method | HTTP request | Description [**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 [**create_dashboard_export_request**](ActionsApi.md#create_dashboard_export_request) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular | (EXPERIMENTAL) Create dashboard tabular export request +[**create_document**](ActionsApi.md#create_document) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents | [**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 @@ -33,16 +34,20 @@ Method | HTTP request | Description [**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 [**dashboard_permissions**](ActionsApi.md#dashboard_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions | Get Dashboard Permissions +[**delete_document**](ActionsApi.md#delete_document) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents/{filename} | [**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 [**explain_afm**](ActionsApi.md#explain_afm) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/explain | AFM explain resource. [**forecast**](ActionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | (BETA) Smart functions - Forecast [**forecast_result**](ActionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | (BETA) Smart functions - Forecast Result +[**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_logical_model_aac**](ActionsApi.md#generate_logical_model_aac) | **POST** /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModelAac | Generate logical data model in AAC format 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 [**get_data_source_schemata**](ActionsApi.md#get_data_source_schemata) | **GET** /api/v1/actions/dataSources/{dataSourceId}/scanSchemata | Get a list of schema names of a database [**get_dependent_entities_graph**](ActionsApi.md#get_dependent_entities_graph) | **GET** /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph | Computes the dependent entities graph [**get_dependent_entities_graph_from_entry_points**](ActionsApi.md#get_dependent_entities_graph_from_entry_points) | **POST** /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph | Computes the dependent entities graph from given entry points +[**get_document**](ActionsApi.md#get_document) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents/{filename} | [**get_exported_file**](ActionsApi.md#get_exported_file) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId} | Retrieve exported files [**get_image_export**](ActionsApi.md#get_image_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/image/{exportId} | (EXPERIMENTAL) Retrieve exported files [**get_image_export_metadata**](ActionsApi.md#get_image_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context @@ -59,6 +64,7 @@ Method | HTTP request | Description [**inherited_entity_prefixes**](ActionsApi.md#inherited_entity_prefixes) | **GET** /api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes | Get used entity prefixes in hierarchy [**key_driver_analysis**](ActionsApi.md#key_driver_analysis) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers | (EXPERIMENTAL) Compute key driver analysis [**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 +[**list_documents**](ActionsApi.md#list_documents) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents | [**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_dashboard_permissions**](ActionsApi.md#manage_dashboard_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions | Manage Permissions for a Dashboard @@ -75,6 +81,7 @@ Method | HTTP request | Description [**outlier_detection_result**](ActionsApi.md#outlier_detection_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers/result/{resultId} | (BETA) Outlier Detection Result [**overridden_child_entities**](ActionsApi.md#overridden_child_entities) | **GET** /api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities | Finds identifier overrides in workspace hierarchy. [**particular_platform_usage**](ActionsApi.md#particular_platform_usage) | **POST** /api/v1/actions/collectUsage | Info about the platform usage for particular items. +[**patch_document**](ActionsApi.md#patch_document) | **PATCH** /api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents/{filename} | [**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 [**register_upload_notification**](ActionsApi.md#register_upload_notification) | **POST** /api/v1/actions/dataSources/{dataSourceId}/uploadNotification | Register an upload notification @@ -88,12 +95,16 @@ Method | HTTP request | Description [**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 +[**search_knowledge**](ActionsApi.md#search_knowledge) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/knowledge/search | +[**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. [**switch_active_identity_provider**](ActionsApi.md#switch_active_identity_provider) | **POST** /api/v1/actions/organization/switchActiveIdentityProvider | Switch Active Identity Provider [**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 [**test_existing_notification_channel**](ActionsApi.md#test_existing_notification_channel) | **POST** /api/v1/actions/notificationChannels/{notificationChannelId}/test | Test existing notification channel. +[**test_llm_provider**](ActionsApi.md#test_llm_provider) | **POST** /api/v1/actions/ai/llmProvider/test | Test LLM Provider +[**test_llm_provider_by_id**](ActionsApi.md#test_llm_provider_by_id) | **POST** /api/v1/actions/ai/llmProvider/{llmProviderId}/test | Test LLM Provider By Id [**test_notification_channel**](ActionsApi.md#test_notification_channel) | **POST** /api/v1/actions/notificationChannels/test | Test notification channel. [**trigger_automation**](ActionsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation. [**trigger_existing_automation**](ActionsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation. @@ -105,6 +116,7 @@ Method | HTTP request | Description [**unsubscribe_organization_automations**](ActionsApi.md#unsubscribe_organization_automations) | **POST** /api/v1/actions/organization/automations/unsubscribe | Unsubscribe from selected automations across all workspaces [**unsubscribe_selected_workspace_automations**](ActionsApi.md#unsubscribe_selected_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from selected automations in the workspace [**unsubscribe_workspace_automations**](ActionsApi.md#unsubscribe_workspace_automations) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from all automations in the workspace +[**upsert_document**](ActionsApi.md#upsert_document) | **PUT** /api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents | [**validate_llm_endpoint**](ActionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/llmEndpoint/test | Validate LLM Endpoint [**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 [**workspace_resolve_all_settings**](ActionsApi.md#workspace_resolve_all_settings) | **GET** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for all settings. @@ -1655,6 +1667,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -1875,6 +1902,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -2018,6 +2060,83 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **create_document** +> CreateKnowledgeDocumentResponseDto create_document(workspace_id, create_knowledge_document_request_dto) + + + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.create_knowledge_document_response_dto import CreateKnowledgeDocumentResponseDto +from gooddata_api_client.model.create_knowledge_document_request_dto import CreateKnowledgeDocumentRequestDto +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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 + create_knowledge_document_request_dto = CreateKnowledgeDocumentRequestDto( + content="content_example", + filename="filename_example", + page_boundaries=[ + 1, + ], + scopes=[ + "scopes_example", + ], + title="title_example", + ) # CreateKnowledgeDocumentRequestDto | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.create_document(workspace_id, create_knowledge_document_request_dto) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->create_document: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **create_knowledge_document_request_dto** | [**CreateKnowledgeDocumentRequestDto**](CreateKnowledgeDocumentRequestDto.md)| | + +### Return type + +[**CreateKnowledgeDocumentResponseDto**](CreateKnowledgeDocumentResponseDto.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) + # **create_image_export** > ExportResponse create_image_export(workspace_id, image_export_request) @@ -2246,6 +2365,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -2634,6 +2768,72 @@ 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) + +# **delete_document** +> DeleteKnowledgeDocumentResponseDto delete_document(workspace_id, filename) + + + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.delete_knowledge_document_response_dto import DeleteKnowledgeDocumentResponseDto +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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 + filename = "filename_example" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.delete_document(workspace_id, filename) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->delete_document: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **filename** | **str**| | + +### Return type + +[**DeleteKnowledgeDocumentResponseDto**](DeleteKnowledgeDocumentResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | @@ -2836,6 +3036,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -3082,6 +3297,79 @@ 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_description** +> GenerateDescriptionResponse generate_description(workspace_id, generate_description_request) + +Generate Description for Analytics Object + +Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.generate_description_request import GenerateDescriptionRequest +from gooddata_api_client.model.generate_description_response import GenerateDescriptionResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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 + generate_description_request = GenerateDescriptionRequest( + object_id="object_id_example", + object_type="Visualization", + ) # GenerateDescriptionRequest | + + # example passing only required values which don't have defaults set + try: + # Generate Description for Analytics Object + api_response = api_instance.generate_description(workspace_id, generate_description_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->generate_description: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **generate_description_request** | [**GenerateDescriptionRequest**](GenerateDescriptionRequest.md)| | + +### Return type + +[**GenerateDescriptionResponse**](GenerateDescriptionResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | @@ -3364,12 +3652,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_data_source_schemata** -> DataSourceSchemata get_data_source_schemata(data_source_id) +# **generate_title** +> GenerateTitleResponse generate_title(workspace_id, generate_title_request) -Get a list of schema names of a database +Generate Title for Analytics Object -It scans a database and reads metadata. The result of the request contains a list of schema names of a database. +Generates a title for the specified analytics object. Returns title and a note with details if generation was not performed. ### Example @@ -3378,7 +3666,8 @@ It scans a database and reads metadata. The result of the request contains a lis import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.data_source_schemata import DataSourceSchemata +from gooddata_api_client.model.generate_title_request import GenerateTitleRequest +from gooddata_api_client.model.generate_title_response import GenerateTitleResponse from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3391,15 +3680,19 @@ 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) - data_source_id = "myPostgres" # str | Data source id + workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + generate_title_request = GenerateTitleRequest( + object_id="object_id_example", + object_type="Visualization", + ) # GenerateTitleRequest | # example passing only required values which don't have defaults set try: - # Get a list of schema names of a database - api_response = api_instance.get_data_source_schemata(data_source_id) + # Generate Title for Analytics Object + api_response = api_instance.generate_title(workspace_id, generate_title_request) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->get_data_source_schemata: %s\n" % e) + print("Exception when calling ActionsApi->generate_title: %s\n" % e) ``` @@ -3407,11 +3700,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data_source_id** | **str**| Data source id | + **workspace_id** | **str**| Workspace identifier | + **generate_title_request** | [**GenerateTitleRequest**](GenerateTitleRequest.md)| | ### Return type -[**DataSourceSchemata**](DataSourceSchemata.md) +[**GenerateTitleResponse**](GenerateTitleResponse.md) ### Authorization @@ -3419,7 +3713,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json - **Accept**: application/json @@ -3427,16 +3721,16 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | The result of the scan schemata | - | +**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_dependent_entities_graph** -> DependentEntitiesResponse get_dependent_entities_graph(workspace_id) +# **get_data_source_schemata** +> DataSourceSchemata get_data_source_schemata(data_source_id) -Computes the dependent entities graph +Get a list of schema names of a database -Computes the dependent entities graph +It scans a database and reads metadata. The result of the request contains a list of schema names of a database. ### Example @@ -3445,7 +3739,7 @@ Computes the dependent entities graph import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse +from gooddata_api_client.model.data_source_schemata import DataSourceSchemata from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3458,15 +3752,15 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = actions_api.ActionsApi(api_client) - workspace_id = "workspaceId_example" # str | + data_source_id = "myPostgres" # str | Data source id # example passing only required values which don't have defaults set try: - # Computes the dependent entities graph - api_response = api_instance.get_dependent_entities_graph(workspace_id) + # Get a list of schema names of a database + api_response = api_instance.get_data_source_schemata(data_source_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->get_dependent_entities_graph: %s\n" % e) + print("Exception when calling ActionsApi->get_data_source_schemata: %s\n" % e) ``` @@ -3474,11 +3768,11 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | + **data_source_id** | **str**| Data source id | ### Return type -[**DependentEntitiesResponse**](DependentEntitiesResponse.md) +[**DataSourceSchemata**](DataSourceSchemata.md) ### Authorization @@ -3494,16 +3788,16 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Computes the dependent entities graph | - | +**200** | The result of the scan schemata | - | [[Back to top]](#) [[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_dependent_entities_graph_from_entry_points** -> DependentEntitiesResponse get_dependent_entities_graph_from_entry_points(workspace_id, dependent_entities_request) +# **get_dependent_entities_graph** +> DependentEntitiesResponse get_dependent_entities_graph(workspace_id) -Computes the dependent entities graph from given entry points +Computes the dependent entities graph -Computes the dependent entities graph from given entry points +Computes the dependent entities graph ### Example @@ -3512,7 +3806,6 @@ Computes the dependent entities graph from given entry points import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.dependent_entities_request import DependentEntitiesRequest from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse from pprint import pprint # Defining the host is optional and defaults to http://localhost @@ -3527,13 +3820,82 @@ 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 | - dependent_entities_request = DependentEntitiesRequest( - identifiers=[ + + # example passing only required values which don't have defaults set + try: + # Computes the dependent entities graph + api_response = api_instance.get_dependent_entities_graph(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->get_dependent_entities_graph: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + +### Return type + +[**DependentEntitiesResponse**](DependentEntitiesResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Computes the dependent entities graph | - | + +[[Back to top]](#) [[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_dependent_entities_graph_from_entry_points** +> DependentEntitiesResponse get_dependent_entities_graph_from_entry_points(workspace_id, dependent_entities_request) + +Computes the dependent entities graph from given entry points + +Computes the dependent entities graph from given entry points + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.dependent_entities_request import DependentEntitiesRequest +from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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 | + dependent_entities_request = DependentEntitiesRequest( + identifiers=[ EntityIdentifier( id="/6bUUGjjNSwg0_bs", type="metric", ), ], + relation="DEPENDENTS", ) # DependentEntitiesRequest | # example passing only required values which don't have defaults set @@ -3575,6 +3937,72 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_document** +> KnowledgeDocumentMetadataDto get_document(workspace_id, filename) + + + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.knowledge_document_metadata_dto import KnowledgeDocumentMetadataDto +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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 + filename = "filename_example" # str | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.get_document(workspace_id, filename) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->get_document: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **filename** | **str**| | + +### Return type + +[**KnowledgeDocumentMetadataDto**](KnowledgeDocumentMetadataDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_exported_file** > file_type get_exported_file(workspace_id, export_id) @@ -4703,6 +5131,88 @@ 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) + +# **list_documents** +> ListKnowledgeDocumentsResponseDto list_documents(workspace_id) + + + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.list_knowledge_documents_response_dto import ListKnowledgeDocumentsResponseDto +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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 + scopes = [ + "scopes_example", + ] # [str] | (optional) + size = 50 # int | (optional) if omitted the server will use the default value of 50 + page_token = "pageToken_example" # str | (optional) + meta_include = "metaInclude_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.list_documents(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->list_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.list_documents(workspace_id, scopes=scopes, size=size, page_token=page_token, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->list_documents: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **scopes** | **[str]**| | [optional] + **size** | **int**| | [optional] if omitted the server will use the default value of 50 + **page_token** | **str**| | [optional] + **meta_include** | **str**| | [optional] + +### Return type + +[**ListKnowledgeDocumentsResponseDto**](ListKnowledgeDocumentsResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | @@ -5881,6 +6391,81 @@ 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) + +# **patch_document** +> KnowledgeDocumentMetadataDto patch_document(workspace_id, filename, patch_knowledge_document_request_dto) + + + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.knowledge_document_metadata_dto import KnowledgeDocumentMetadataDto +from gooddata_api_client.model.patch_knowledge_document_request_dto import PatchKnowledgeDocumentRequestDto +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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 + filename = "filename_example" # str | + patch_knowledge_document_request_dto = PatchKnowledgeDocumentRequestDto( + is_disabled=True, + scopes=[ + "scopes_example", + ], + title="title_example", + ) # PatchKnowledgeDocumentRequestDto | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.patch_document(workspace_id, filename, patch_knowledge_document_request_dto) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->patch_document: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **filename** | **str**| | + **patch_knowledge_document_request_dto** | [**PatchKnowledgeDocumentRequestDto**](PatchKnowledgeDocumentRequestDto.md)| | + +### Return type + +[**KnowledgeDocumentMetadataDto**](KnowledgeDocumentMetadataDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | @@ -6830,12 +7415,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) -# **set_translations** -> set_translations(workspace_id, xliff) +# **search_knowledge** +> SearchKnowledgeResponseDto search_knowledge(workspace_id, query) -Set translations for entities. -Set translation for existing entities in a particular locale. ### Example @@ -6844,7 +7427,164 @@ Set translation for existing entities in a particular locale. import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.xliff import Xliff +from gooddata_api_client.model.search_knowledge_response_dto import SearchKnowledgeResponseDto +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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 + query = "query_example" # str | + limit = 10 # int | (optional) if omitted the server will use the default value of 10 + min_score = 0.0 # float | (optional) if omitted the server will use the default value of 0.0 + scopes = [ + "scopes_example", + ] # [str] | (optional) + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.search_knowledge(workspace_id, query) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->search_knowledge: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.search_knowledge(workspace_id, query, limit=limit, min_score=min_score, scopes=scopes) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->search_knowledge: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **query** | **str**| | + **limit** | **int**| | [optional] if omitted the server will use the default value of 10 + **min_score** | **float**| | [optional] if omitted the server will use the default value of 0.0 + **scopes** | **[str]**| | [optional] + +### Return type + +[**SearchKnowledgeResponseDto**](SearchKnowledgeResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_certification** +> set_certification(workspace_id, set_certification_request) + +Set Certification + +Set or clear the certification (e.g. CERTIFIED) of a workspace entity. Requires MANAGE permission. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.set_certification_request import SetCertificationRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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 | + set_certification_request = SetCertificationRequest( + id="total-sales", + message="message_example", + status="CERTIFIED", + type="metric", + ) # SetCertificationRequest | + + # example passing only required values which don't have defaults set + try: + # Set Certification + api_instance.set_certification(workspace_id, set_certification_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->set_certification: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **set_certification_request** | [**SetCertificationRequest**](SetCertificationRequest.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) + +# **set_translations** +> set_translations(workspace_id, xliff) + +Set translations for entities. + +Set translation for existing entities in a particular locale. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.xliff import Xliff from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -7338,6 +8078,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) +# **test_llm_provider** +> TestLlmProviderResponse test_llm_provider(test_llm_provider_definition_request) + +Test LLM Provider + +Tests LLM provider connectivity with a full definition. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse +from gooddata_api_client.model.test_llm_provider_definition_request import TestLlmProviderDefinitionRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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) + test_llm_provider_definition_request = TestLlmProviderDefinitionRequest( + models=[ + LlmModel( + family="OPENAI", + id="id_example", + ), + ], + provider_config=TestLlmProviderDefinitionRequestProviderConfig(None), + ) # TestLlmProviderDefinitionRequest | + + # example passing only required values which don't have defaults set + try: + # Test LLM Provider + api_response = api_instance.test_llm_provider(test_llm_provider_definition_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->test_llm_provider: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **test_llm_provider_definition_request** | [**TestLlmProviderDefinitionRequest**](TestLlmProviderDefinitionRequest.md)| | + +### Return type + +[**TestLlmProviderResponse**](TestLlmProviderResponse.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) + +# **test_llm_provider_by_id** +> TestLlmProviderResponse test_llm_provider_by_id(llm_provider_id) + +Test LLM Provider By Id + +Tests an existing LLM provider connectivity by its ID. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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) + llm_provider_id = "llmProviderId_example" # str | + + # example passing only required values which don't have defaults set + try: + # Test LLM Provider By Id + api_response = api_instance.test_llm_provider_by_id(llm_provider_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->test_llm_provider_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **llm_provider_id** | **str**| | + +### Return type + +[**TestLlmProviderResponse**](TestLlmProviderResponse.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) + # **test_notification_channel** > TestResponse test_notification_channel(test_destination_request) @@ -7572,6 +8455,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -8321,6 +9219,83 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **upsert_document** +> UpsertKnowledgeDocumentResponseDto upsert_document(workspace_id, upsert_knowledge_document_request_dto) + + + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.upsert_knowledge_document_response_dto import UpsertKnowledgeDocumentResponseDto +from gooddata_api_client.model.upsert_knowledge_document_request_dto import UpsertKnowledgeDocumentRequestDto +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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 + upsert_knowledge_document_request_dto = UpsertKnowledgeDocumentRequestDto( + content="content_example", + filename="filename_example", + page_boundaries=[ + 1, + ], + scopes=[ + "scopes_example", + ], + title="title_example", + ) # UpsertKnowledgeDocumentRequestDto | + + # example passing only required values which don't have defaults set + try: + api_response = api_instance.upsert_document(workspace_id, upsert_knowledge_document_request_dto) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->upsert_document: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **upsert_knowledge_document_request_dto** | [**UpsertKnowledgeDocumentRequestDto**](UpsertKnowledgeDocumentRequestDto.md)| | + +### Return type + +[**UpsertKnowledgeDocumentResponseDto**](UpsertKnowledgeDocumentResponseDto.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) + # **validate_llm_endpoint** > ValidateLLMEndpointResponse validate_llm_endpoint(validate_llm_endpoint_request) diff --git a/gooddata-api-client/docs/AllTimeDateFilter.md b/gooddata-api-client/docs/AllTimeDateFilter.md new file mode 100644 index 000000000..2ec0ccea0 --- /dev/null +++ b/gooddata-api-client/docs/AllTimeDateFilter.md @@ -0,0 +1,13 @@ +# AllTimeDateFilter + +An all-time date filter that does not restrict by date range. Controls how rows with empty (null/missing) date values are handled. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**all_time_date_filter** | [**AllTimeDateFilterAllTimeDateFilter**](AllTimeDateFilterAllTimeDateFilter.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/AllTimeDateFilterAllTimeDateFilter.md b/gooddata-api-client/docs/AllTimeDateFilterAllTimeDateFilter.md new file mode 100644 index 000000000..c0a4fc42c --- /dev/null +++ b/gooddata-api-client/docs/AllTimeDateFilterAllTimeDateFilter.md @@ -0,0 +1,16 @@ +# AllTimeDateFilterAllTimeDateFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dataset** | [**AfmObjectIdentifierDataset**](AfmObjectIdentifierDataset.md) | | +**apply_on_result** | **bool** | | [optional] +**empty_value_handling** | **str** | Specifies how rows with empty (null/missing) date values should be handled. INCLUDE means no filtering effect (default), EXCLUDE removes rows with null dates, ONLY keeps only rows with null dates. | [optional] if omitted the server will use the default value of "INCLUDE" +**granularity** | **str** | Date granularity used to resolve the date attribute label for null value checks. Defaults to DAY if not specified. | [optional] if omitted the server will use the default value of "DAY" +**local_identifier** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/AnalyticsModelApi.md b/gooddata-api-client/docs/AnalyticsModelApi.md index eca8fd880..91cfda19d 100644 --- a/gooddata-api-client/docs/AnalyticsModelApi.md +++ b/gooddata-api-client/docs/AnalyticsModelApi.md @@ -128,6 +128,13 @@ with gooddata_api_client.ApiClient() as api_client: ], analytical_dashboards=[ DeclarativeAnalyticalDashboard( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -152,14 +159,14 @@ with gooddata_api_client.ApiClient() as api_client: attribute_hierarchies=[ DeclarativeAttributeHierarchy( content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Simple number for total goods in current production.", id="hierarchy-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -171,14 +178,14 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_plugins=[ DeclarativeDashboardPlugin( content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Three dimensional view of data.", id="dashboard-plugin-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -189,14 +196,14 @@ with gooddata_api_client.ApiClient() as api_client: ], export_definitions=[ DeclarativeExportDefinition( - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Simple number for total goods in current production.", id="export-definition-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -241,8 +248,15 @@ with gooddata_api_client.ApiClient() as api_client: ], metrics=[ DeclarativeMetric( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -251,7 +265,7 @@ with gooddata_api_client.ApiClient() as api_client: id="total-sales", is_hidden=False, is_hidden_from_kda=False, - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -262,8 +276,15 @@ with gooddata_api_client.ApiClient() as api_client: ], visualization_objects=[ DeclarativeVisualizationObject( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -271,7 +292,7 @@ with gooddata_api_client.ApiClient() as api_client: description="Simple number for total goods in current production.", id="visualization-1", is_hidden=False, - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", diff --git a/gooddata-api-client/docs/AnomalyDetectionConfig.md b/gooddata-api-client/docs/AnomalyDetectionConfig.md new file mode 100644 index 000000000..63b7eaeb5 --- /dev/null +++ b/gooddata-api-client/docs/AnomalyDetectionConfig.md @@ -0,0 +1,13 @@ +# AnomalyDetectionConfig + +Anomaly detection configuration. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sensitivity** | **str** | Outlier sensitivity level. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/AutomationsApi.md b/gooddata-api-client/docs/AutomationsApi.md index cf1878bb6..c569e36b5 100644 --- a/gooddata-api-client/docs/AutomationsApi.md +++ b/gooddata-api-client/docs/AutomationsApi.md @@ -181,6 +181,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -1086,6 +1101,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -1792,6 +1822,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -2101,6 +2146,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -2935,6 +2995,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), diff --git a/gooddata-api-client/docs/AwsBedrockAccessKeyAuth.md b/gooddata-api-client/docs/AwsBedrockAccessKeyAuth.md new file mode 100644 index 000000000..88acfc280 --- /dev/null +++ b/gooddata-api-client/docs/AwsBedrockAccessKeyAuth.md @@ -0,0 +1,15 @@ +# AwsBedrockAccessKeyAuth + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Authentication type. | defaults to "ACCESS_KEY" +**access_key_id** | **str, none_type** | AWS Access Key ID. | [optional] +**secret_access_key** | **str, none_type** | AWS Secret Access Key. | [optional] +**session_token** | **str, none_type** | AWS Session Token (for temporary credentials). | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/AwsBedrockAccessKeyAuthAllOf.md b/gooddata-api-client/docs/AwsBedrockAccessKeyAuthAllOf.md new file mode 100644 index 000000000..0e8f1c172 --- /dev/null +++ b/gooddata-api-client/docs/AwsBedrockAccessKeyAuthAllOf.md @@ -0,0 +1,15 @@ +# AwsBedrockAccessKeyAuthAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_key_id** | **str, none_type** | AWS Access Key ID. | [optional] +**secret_access_key** | **str, none_type** | AWS Secret Access Key. | [optional] +**session_token** | **str, none_type** | AWS Session Token (for temporary credentials). | [optional] +**type** | **str** | Authentication type. | [optional] if omitted the server will use the default value of "ACCESS_KEY" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/AwsBedrockProviderConfig.md b/gooddata-api-client/docs/AwsBedrockProviderConfig.md new file mode 100644 index 000000000..e1c22ed57 --- /dev/null +++ b/gooddata-api-client/docs/AwsBedrockProviderConfig.md @@ -0,0 +1,15 @@ +# AwsBedrockProviderConfig + +Configuration for AWS Bedrock provider. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**auth** | [**BedrockProviderAuth**](BedrockProviderAuth.md) | | +**region** | **str** | AWS region for Bedrock. | +**type** | **str** | Provider type. | defaults to "AWS_BEDROCK" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/AzureFoundryApiKeyAuth.md b/gooddata-api-client/docs/AzureFoundryApiKeyAuth.md new file mode 100644 index 000000000..5c562b557 --- /dev/null +++ b/gooddata-api-client/docs/AzureFoundryApiKeyAuth.md @@ -0,0 +1,13 @@ +# AzureFoundryApiKeyAuth + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Authentication type. | defaults to "API_KEY" +**api_key** | **str, none_type** | Azure API key. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/AzureFoundryApiKeyAuthAllOf.md b/gooddata-api-client/docs/AzureFoundryApiKeyAuthAllOf.md new file mode 100644 index 000000000..e95e2656d --- /dev/null +++ b/gooddata-api-client/docs/AzureFoundryApiKeyAuthAllOf.md @@ -0,0 +1,13 @@ +# AzureFoundryApiKeyAuthAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**api_key** | **str, none_type** | Azure API key. | [optional] +**type** | **str** | Authentication type. | [optional] if omitted the server will use the default value of "API_KEY" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/AzureFoundryProviderAuth.md b/gooddata-api-client/docs/AzureFoundryProviderAuth.md new file mode 100644 index 000000000..4744d526c --- /dev/null +++ b/gooddata-api-client/docs/AzureFoundryProviderAuth.md @@ -0,0 +1,14 @@ +# AzureFoundryProviderAuth + +Authentication configuration. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**api_key** | **str, none_type** | Azure API key. | [optional] +**type** | **str** | Authentication type. | [optional] if omitted the server will use the default value of "API_KEY" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/AzureFoundryProviderConfig.md b/gooddata-api-client/docs/AzureFoundryProviderConfig.md new file mode 100644 index 000000000..08a6da0b6 --- /dev/null +++ b/gooddata-api-client/docs/AzureFoundryProviderConfig.md @@ -0,0 +1,15 @@ +# AzureFoundryProviderConfig + +Configuration for Azure Foundry provider. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**auth** | [**AzureFoundryProviderAuth**](AzureFoundryProviderAuth.md) | | +**endpoint** | **str** | Azure AI inference endpoint URL. | +**type** | **str** | Provider type. | defaults to "AZURE_FOUNDRY" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/BedrockProviderAuth.md b/gooddata-api-client/docs/BedrockProviderAuth.md new file mode 100644 index 000000000..c7e41575c --- /dev/null +++ b/gooddata-api-client/docs/BedrockProviderAuth.md @@ -0,0 +1,16 @@ +# BedrockProviderAuth + +Authentication configuration. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_key_id** | **str, none_type** | AWS Access Key ID. | [optional] +**secret_access_key** | **str, none_type** | AWS Secret Access Key. | [optional] +**session_token** | **str, none_type** | AWS Session Token (for temporary credentials). | [optional] +**type** | **str** | Authentication type. | [optional] if omitted the server will use the default value of "ACCESS_KEY" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/CertificationApi.md b/gooddata-api-client/docs/CertificationApi.md new file mode 100644 index 000000000..e6536cb65 --- /dev/null +++ b/gooddata-api-client/docs/CertificationApi.md @@ -0,0 +1,82 @@ +# gooddata_api_client.CertificationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**set_certification**](CertificationApi.md#set_certification) | **POST** /api/v1/actions/workspaces/{workspaceId}/setCertification | Set Certification + + +# **set_certification** +> set_certification(workspace_id, set_certification_request) + +Set Certification + +Set or clear the certification (e.g. CERTIFIED) of a workspace entity. Requires MANAGE permission. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import certification_api +from gooddata_api_client.model.set_certification_request import SetCertificationRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = certification_api.CertificationApi(api_client) + workspace_id = "workspaceId_example" # str | + set_certification_request = SetCertificationRequest( + id="total-sales", + message="message_example", + status="CERTIFIED", + type="metric", + ) # SetCertificationRequest | + + # example passing only required values which don't have defaults set + try: + # Set Certification + api_instance.set_certification(workspace_id, set_certification_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling CertificationApi->set_certification: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **set_certification_request** | [**SetCertificationRequest**](SetCertificationRequest.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/ChangeAnalysisParamsFiltersInner.md b/gooddata-api-client/docs/ChangeAnalysisParamsFiltersInner.md index 0f091de02..0c4ac924c 100644 --- a/gooddata-api-client/docs/ChangeAnalysisParamsFiltersInner.md +++ b/gooddata-api-client/docs/ChangeAnalysisParamsFiltersInner.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **ranking_filter** | [**RankingFilterRankingFilter**](RankingFilterRankingFilter.md) | | [optional] **absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] **relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | [optional] +**all_time_date_filter** | [**AllTimeDateFilterAllTimeDateFilter**](AllTimeDateFilterAllTimeDateFilter.md) | | [optional] **negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | [optional] **positive_attribute_filter** | [**PositiveAttributeFilterPositiveAttributeFilter**](PositiveAttributeFilterPositiveAttributeFilter.md) | | [optional] **match_attribute_filter** | [**MatchAttributeFilterMatchAttributeFilter**](MatchAttributeFilterMatchAttributeFilter.md) | | [optional] diff --git a/gooddata-api-client/docs/ClusteringConfig.md b/gooddata-api-client/docs/ClusteringConfig.md new file mode 100644 index 000000000..245f4a347 --- /dev/null +++ b/gooddata-api-client/docs/ClusteringConfig.md @@ -0,0 +1,14 @@ +# 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/ComputationApi.md b/gooddata-api-client/docs/ComputationApi.md index 5f5316d8d..e68210423 100644 --- a/gooddata-api-client/docs/ComputationApi.md +++ b/gooddata-api-client/docs/ComputationApi.md @@ -520,6 +520,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -740,6 +755,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -842,6 +872,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), diff --git a/gooddata-api-client/docs/CreateKnowledgeDocumentRequestDto.md b/gooddata-api-client/docs/CreateKnowledgeDocumentRequestDto.md new file mode 100644 index 000000000..7fb5d2c15 --- /dev/null +++ b/gooddata-api-client/docs/CreateKnowledgeDocumentRequestDto.md @@ -0,0 +1,16 @@ +# CreateKnowledgeDocumentRequestDto + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | **str** | | +**filename** | **str** | | +**page_boundaries** | **[int]** | | [optional] +**scopes** | **[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/CreateKnowledgeDocumentResponseDto.md b/gooddata-api-client/docs/CreateKnowledgeDocumentResponseDto.md new file mode 100644 index 000000000..f06a7a5ed --- /dev/null +++ b/gooddata-api-client/docs/CreateKnowledgeDocumentResponseDto.md @@ -0,0 +1,15 @@ +# CreateKnowledgeDocumentResponseDto + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filename** | **str** | | +**message** | **str** | | +**num_chunks** | **int** | | +**success** | **bool** | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-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 index 66c0bf3e4..fc05128df 100644 --- a/gooddata-api-client/docs/CreatedVisualization.md +++ b/gooddata-api-client/docs/CreatedVisualization.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes **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] diff --git a/gooddata-api-client/docs/DashboardDateFilterDateFilter.md b/gooddata-api-client/docs/DashboardDateFilterDateFilter.md index 9e3b0428f..e76bad2c0 100644 --- a/gooddata-api-client/docs/DashboardDateFilterDateFilter.md +++ b/gooddata-api-client/docs/DashboardDateFilterDateFilter.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **attribute** | [**IdentifierRef**](IdentifierRef.md) | | [optional] **bounded_filter** | [**RelativeBoundedDateFilter**](RelativeBoundedDateFilter.md) | | [optional] **data_set** | [**IdentifierRef**](IdentifierRef.md) | | [optional] +**empty_value_handling** | **str** | | [optional] **_from** | [**AacDashboardFilterFrom**](AacDashboardFilterFrom.md) | | [optional] **local_identifier** | **str** | | [optional] **to** | [**AacDashboardFilterFrom**](AacDashboardFilterFrom.md) | | [optional] diff --git a/gooddata-api-client/docs/DashboardsApi.md b/gooddata-api-client/docs/DashboardsApi.md index cb43af9e9..1f01d5637 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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,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) meta_include = [ "metaInclude=permissions,origin,accessInfo,all", @@ -217,7 +217,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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,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 @@ -313,7 +313,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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ @@ -418,7 +418,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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,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) # example passing only required values which don't have defaults set @@ -617,7 +617,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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,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) # example passing only required values which don't have defaults set diff --git a/gooddata-api-client/docs/DateFilter.md b/gooddata-api-client/docs/DateFilter.md index 7efd449c4..20b25cb52 100644 --- a/gooddata-api-client/docs/DateFilter.md +++ b/gooddata-api-client/docs/DateFilter.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] **relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | [optional] +**all_time_date_filter** | [**AllTimeDateFilterAllTimeDateFilter**](AllTimeDateFilterAllTimeDateFilter.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DeclarativeAnalyticalDashboard.md b/gooddata-api-client/docs/DeclarativeAnalyticalDashboard.md index bde1bb0a3..198df35f3 100644 --- a/gooddata-api-client/docs/DeclarativeAnalyticalDashboard.md +++ b/gooddata-api-client/docs/DeclarativeAnalyticalDashboard.md @@ -7,6 +7,10 @@ Name | Type | Description | Notes **content** | [**JsonNode**](JsonNode.md) | | **id** | **str** | Analytical dashboard ID. | **title** | **str** | Analytical dashboard 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] **description** | **str** | Analytical dashboard description. | [optional] diff --git a/gooddata-api-client/docs/DeclarativeMetric.md b/gooddata-api-client/docs/DeclarativeMetric.md index 6fb1f5b7c..a068affcd 100644 --- a/gooddata-api-client/docs/DeclarativeMetric.md +++ b/gooddata-api-client/docs/DeclarativeMetric.md @@ -7,6 +7,10 @@ Name | Type | Description | Notes **content** | [**JsonNode**](JsonNode.md) | | **id** | **str** | Metric ID. | **title** | **str** | Metric 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] **description** | **str** | Metric description. | [optional] diff --git a/gooddata-api-client/docs/DeclarativeVisualizationObject.md b/gooddata-api-client/docs/DeclarativeVisualizationObject.md index b3e60dfc1..1a91a583e 100644 --- a/gooddata-api-client/docs/DeclarativeVisualizationObject.md +++ b/gooddata-api-client/docs/DeclarativeVisualizationObject.md @@ -7,6 +7,10 @@ Name | Type | Description | Notes **content** | [**JsonNode**](JsonNode.md) | | **id** | **str** | Visualization object ID. | **title** | **str** | Visualization object 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] **description** | **str** | Visualization object description. | [optional] diff --git a/gooddata-api-client/docs/DeleteKnowledgeDocumentResponseDto.md b/gooddata-api-client/docs/DeleteKnowledgeDocumentResponseDto.md new file mode 100644 index 000000000..0f8d7a84d --- /dev/null +++ b/gooddata-api-client/docs/DeleteKnowledgeDocumentResponseDto.md @@ -0,0 +1,13 @@ +# DeleteKnowledgeDocumentResponseDto + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | | +**success** | **bool** | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/DependencyGraphApi.md b/gooddata-api-client/docs/DependencyGraphApi.md index 31c38aec2..8d7487368 100644 --- a/gooddata-api-client/docs/DependencyGraphApi.md +++ b/gooddata-api-client/docs/DependencyGraphApi.md @@ -111,6 +111,7 @@ with gooddata_api_client.ApiClient() as api_client: type="metric", ), ], + relation="DEPENDENTS", ) # DependentEntitiesRequest | # example passing only required values which don't have defaults set diff --git a/gooddata-api-client/docs/DependentEntitiesRequest.md b/gooddata-api-client/docs/DependentEntitiesRequest.md index 248fd5953..df09341c2 100644 --- a/gooddata-api-client/docs/DependentEntitiesRequest.md +++ b/gooddata-api-client/docs/DependentEntitiesRequest.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **identifiers** | [**[EntityIdentifier]**](EntityIdentifier.md) | | +**relation** | **str** | Entity relation for graph traversal from the entry points. DEPENDENTS returns entities that depend on the entry points. DEPENDENCIES returns entities that the entry points depend on. | [optional] if omitted the server will use the default value of "DEPENDENTS" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/EntitiesApi.md b/gooddata-api-client/docs/EntitiesApi.md index 9a6b6699f..6216829ff 100644 --- a/gooddata-api-client/docs/EntitiesApi.md +++ b/gooddata-api-client/docs/EntitiesApi.md @@ -22,6 +22,7 @@ Method | HTTP request | Description [**create_entity_jwks**](EntitiesApi.md#create_entity_jwks) | **POST** /api/v1/entities/jwks | Post Jwks [**create_entity_knowledge_recommendations**](EntitiesApi.md#create_entity_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | [**create_entity_llm_endpoints**](EntitiesApi.md#create_entity_llm_endpoints) | **POST** /api/v1/entities/llmEndpoints | Post LLM endpoint entities +[**create_entity_llm_providers**](EntitiesApi.md#create_entity_llm_providers) | **POST** /api/v1/entities/llmProviders | Post LLM Provider entities [**create_entity_memory_items**](EntitiesApi.md#create_entity_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems | [**create_entity_metrics**](EntitiesApi.md#create_entity_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics | Post Metrics [**create_entity_notification_channels**](EntitiesApi.md#create_entity_notification_channels) | **POST** /api/v1/entities/notificationChannels | Post Notification Channel entities @@ -54,6 +55,7 @@ Method | HTTP request | Description [**delete_entity_jwks**](EntitiesApi.md#delete_entity_jwks) | **DELETE** /api/v1/entities/jwks/{id} | Delete Jwk [**delete_entity_knowledge_recommendations**](EntitiesApi.md#delete_entity_knowledge_recommendations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | [**delete_entity_llm_endpoints**](EntitiesApi.md#delete_entity_llm_endpoints) | **DELETE** /api/v1/entities/llmEndpoints/{id} | +[**delete_entity_llm_providers**](EntitiesApi.md#delete_entity_llm_providers) | **DELETE** /api/v1/entities/llmProviders/{id} | Delete LLM Provider entity [**delete_entity_memory_items**](EntitiesApi.md#delete_entity_memory_items) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | [**delete_entity_metrics**](EntitiesApi.md#delete_entity_metrics) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Delete a Metric [**delete_entity_notification_channels**](EntitiesApi.md#delete_entity_notification_channels) | **DELETE** /api/v1/entities/notificationChannels/{id} | Delete Notification Channel entity @@ -94,6 +96,7 @@ Method | HTTP request | Description [**get_all_entities_knowledge_recommendations**](EntitiesApi.md#get_all_entities_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | [**get_all_entities_labels**](EntitiesApi.md#get_all_entities_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels | Get all Labels [**get_all_entities_llm_endpoints**](EntitiesApi.md#get_all_entities_llm_endpoints) | **GET** /api/v1/entities/llmEndpoints | Get all LLM endpoint entities +[**get_all_entities_llm_providers**](EntitiesApi.md#get_all_entities_llm_providers) | **GET** /api/v1/entities/llmProviders | Get all LLM Provider entities [**get_all_entities_memory_items**](EntitiesApi.md#get_all_entities_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems | [**get_all_entities_metrics**](EntitiesApi.md#get_all_entities_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics | Get all Metrics [**get_all_entities_notification_channel_identifiers**](EntitiesApi.md#get_all_entities_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers | @@ -138,6 +141,7 @@ Method | HTTP request | Description [**get_entity_knowledge_recommendations**](EntitiesApi.md#get_entity_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | [**get_entity_labels**](EntitiesApi.md#get_entity_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Get a Label [**get_entity_llm_endpoints**](EntitiesApi.md#get_entity_llm_endpoints) | **GET** /api/v1/entities/llmEndpoints/{id} | Get LLM endpoint entity +[**get_entity_llm_providers**](EntitiesApi.md#get_entity_llm_providers) | **GET** /api/v1/entities/llmProviders/{id} | Get LLM Provider entity [**get_entity_memory_items**](EntitiesApi.md#get_entity_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | [**get_entity_metrics**](EntitiesApi.md#get_entity_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Get a Metric [**get_entity_notification_channel_identifiers**](EntitiesApi.md#get_entity_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers/{id} | @@ -178,6 +182,7 @@ Method | HTTP request | Description [**patch_entity_knowledge_recommendations**](EntitiesApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | [**patch_entity_labels**](EntitiesApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label (beta) [**patch_entity_llm_endpoints**](EntitiesApi.md#patch_entity_llm_endpoints) | **PATCH** /api/v1/entities/llmEndpoints/{id} | Patch LLM endpoint entity +[**patch_entity_llm_providers**](EntitiesApi.md#patch_entity_llm_providers) | **PATCH** /api/v1/entities/llmProviders/{id} | Patch LLM Provider entity [**patch_entity_memory_items**](EntitiesApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | [**patch_entity_metrics**](EntitiesApi.md#patch_entity_metrics) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Patch a Metric [**patch_entity_notification_channels**](EntitiesApi.md#patch_entity_notification_channels) | **PATCH** /api/v1/entities/notificationChannels/{id} | Patch Notification Channel entity @@ -232,6 +237,7 @@ Method | HTTP request | Description [**update_entity_jwks**](EntitiesApi.md#update_entity_jwks) | **PUT** /api/v1/entities/jwks/{id} | Put Jwk [**update_entity_knowledge_recommendations**](EntitiesApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | [**update_entity_llm_endpoints**](EntitiesApi.md#update_entity_llm_endpoints) | **PUT** /api/v1/entities/llmEndpoints/{id} | PUT LLM endpoint entity +[**update_entity_llm_providers**](EntitiesApi.md#update_entity_llm_providers) | **PUT** /api/v1/entities/llmProviders/{id} | PUT LLM Provider entity [**update_entity_memory_items**](EntitiesApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | [**update_entity_metrics**](EntitiesApi.md#update_entity_metrics) | **PUT** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Put a Metric [**update_entity_notification_channels**](EntitiesApi.md#update_entity_notification_channels) | **PUT** /api/v1/entities/notificationChannels/{id} | Put Notification Channel entity @@ -293,7 +299,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiAnalyticalDashboardPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,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) meta_include = [ "metaInclude=permissions,origin,accessInfo,all", @@ -672,6 +678,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -2189,6 +2210,91 @@ 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_llm_providers** +> JsonApiLlmProviderOutDocument create_entity_llm_providers(json_api_llm_provider_in_document) + +Post LLM Provider entities + +LLM Provider - connection configuration for LLM services + +### Example + + +```python +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_in_document import JsonApiLlmProviderInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + json_api_llm_provider_in_document = JsonApiLlmProviderInDocument( + data=JsonApiLlmProviderIn( + 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(None), + ), + id="id1", + type="llmProvider", + ), + ) # JsonApiLlmProviderInDocument | + + # example passing only required values which don't have defaults set + try: + # Post LLM Provider entities + api_response = api_instance.create_entity_llm_providers(json_api_llm_provider_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_llm_providers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **json_api_llm_provider_in_document** | [**JsonApiLlmProviderInDocument**](JsonApiLlmProviderInDocument.md)| | + +### Return type + +[**JsonApiLlmProviderOutDocument**](JsonApiLlmProviderOutDocument.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 | @@ -2348,7 +2454,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiMetricPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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", @@ -3064,7 +3170,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiVisualizationObjectPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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", @@ -4816,7 +4922,7 @@ 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;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: @@ -4833,6 +4939,79 @@ with gooddata_api_client.ApiClient() as api_client: ``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +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_llm_providers** +> delete_entity_llm_providers(id) + +Delete LLM Provider entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + 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: + # 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_llm_providers: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete LLM Provider entity + api_instance.delete_entity_llm_providers(id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->delete_entity_llm_providers: %s\n" % e) +``` + + ### Parameters Name | Type | Description | Notes @@ -6109,7 +6288,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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,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 @@ -8144,7 +8323,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;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 = [ @@ -8189,6 +8368,84 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_llm_providers** +> JsonApiLlmProviderOutList get_all_entities_llm_providers() + +Get all LLM Provider entities + +### Example + + +```python +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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + filter = "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 = [ + "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 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_llm_providers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiLlmProviderOutList**](JsonApiLlmProviderOutList.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 | @@ -8320,7 +8577,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 @@ -9159,7 +9416,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 @@ -9833,7 +10090,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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ @@ -11816,7 +12073,7 @@ 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;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: @@ -11858,6 +12115,82 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_llm_providers** +> JsonApiLlmProviderOutDocument get_entity_llm_providers(id) + +Get LLM Provider entity + +### Example + + +```python +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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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;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 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_llm_providers: %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) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_llm_providers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiLlmProviderOutDocument**](JsonApiLlmProviderOutDocument.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 | @@ -11981,7 +12314,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 = [ @@ -12863,7 +13196,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 = [ @@ -13382,7 +13715,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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,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) # example passing only required values which don't have defaults set @@ -13789,6 +14122,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -15735,7 +16083,7 @@ with gooddata_api_client.ApiClient() as api_client: type="llmEndpoint", ), ) # JsonApiLlmEndpointPatchDocument | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: @@ -15778,6 +16126,102 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_llm_providers** +> JsonApiLlmProviderOutDocument patch_entity_llm_providers(id, json_api_llm_provider_patch_document) + +Patch LLM Provider entity + +### Example + + +```python +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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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_llm_provider_patch_document = JsonApiLlmProviderPatchDocument( + data=JsonApiLlmProviderPatch( + attributes=JsonApiLlmProviderPatchAttributes( + default_model_id="default_model_id_example", + description="description_example", + models=[ + JsonApiLlmProviderInAttributesModelsInner( + family="OPENAI", + id="id_example", + ), + ], + name="name_example", + provider_config=JsonApiLlmProviderInAttributesProviderConfig(None), + ), + id="id1", + type="llmProvider", + ), + ) # 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 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_llm_providers: %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) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_llm_providers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **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 + +[**JsonApiLlmProviderOutDocument**](JsonApiLlmProviderOutDocument.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 | @@ -15939,7 +16383,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 @@ -16729,7 +17173,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 @@ -19411,7 +19855,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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,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) # example passing only required values which don't have defaults set @@ -19716,6 +20160,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -21371,7 +21830,7 @@ with gooddata_api_client.ApiClient() as api_client: type="llmEndpoint", ), ) # JsonApiLlmEndpointInDocument | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: @@ -21414,6 +21873,102 @@ 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_llm_providers** +> JsonApiLlmProviderOutDocument update_entity_llm_providers(id, json_api_llm_provider_in_document) + +PUT LLM Provider entity + +### Example + + +```python +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_in_document import JsonApiLlmProviderInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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_llm_provider_in_document = JsonApiLlmProviderInDocument( + data=JsonApiLlmProviderIn( + 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(None), + ), + id="id1", + type="llmProvider", + ), + ) # JsonApiLlmProviderInDocument | + 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: + # PUT LLM Provider entity + api_response = api_instance.update_entity_llm_providers(id, json_api_llm_provider_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_llm_providers: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # PUT LLM Provider entity + api_response = api_instance.update_entity_llm_providers(id, json_api_llm_provider_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_llm_providers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_llm_provider_in_document** | [**JsonApiLlmProviderInDocument**](JsonApiLlmProviderInDocument.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) + +### 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 | @@ -21575,7 +22130,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 @@ -22455,7 +23010,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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/FailedOperation.md b/gooddata-api-client/docs/FailedOperation.md index 613d680e0..8f156850f 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. | +**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. | **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/FilterDefinition.md b/gooddata-api-client/docs/FilterDefinition.md index 30ada85c5..f4fcb4948 100644 --- a/gooddata-api-client/docs/FilterDefinition.md +++ b/gooddata-api-client/docs/FilterDefinition.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes **compound_measure_value_filter** | [**CompoundMeasureValueFilterCompoundMeasureValueFilter**](CompoundMeasureValueFilterCompoundMeasureValueFilter.md) | | [optional] **absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] **relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | [optional] +**all_time_date_filter** | [**AllTimeDateFilterAllTimeDateFilter**](AllTimeDateFilterAllTimeDateFilter.md) | | [optional] **negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | [optional] **positive_attribute_filter** | [**PositiveAttributeFilterPositiveAttributeFilter**](PositiveAttributeFilterPositiveAttributeFilter.md) | | [optional] **match_attribute_filter** | [**MatchAttributeFilterMatchAttributeFilter**](MatchAttributeFilterMatchAttributeFilter.md) | | [optional] diff --git a/gooddata-api-client/docs/FilterDefinitionForSimpleMeasure.md b/gooddata-api-client/docs/FilterDefinitionForSimpleMeasure.md index fcf923832..5826ccfce 100644 --- a/gooddata-api-client/docs/FilterDefinitionForSimpleMeasure.md +++ b/gooddata-api-client/docs/FilterDefinitionForSimpleMeasure.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] **relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | [optional] +**all_time_date_filter** | [**AllTimeDateFilterAllTimeDateFilter**](AllTimeDateFilterAllTimeDateFilter.md) | | [optional] **negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | [optional] **positive_attribute_filter** | [**PositiveAttributeFilterPositiveAttributeFilter**](PositiveAttributeFilterPositiveAttributeFilter.md) | | [optional] **match_attribute_filter** | [**MatchAttributeFilterMatchAttributeFilter**](MatchAttributeFilterMatchAttributeFilter.md) | | [optional] diff --git a/gooddata-api-client/docs/ForecastConfig.md b/gooddata-api-client/docs/ForecastConfig.md new file mode 100644 index 000000000..f302b7a0e --- /dev/null +++ b/gooddata-api-client/docs/ForecastConfig.md @@ -0,0 +1,15 @@ +# 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/GenerateDescriptionRequest.md b/gooddata-api-client/docs/GenerateDescriptionRequest.md new file mode 100644 index 000000000..ecb0e01a2 --- /dev/null +++ b/gooddata-api-client/docs/GenerateDescriptionRequest.md @@ -0,0 +1,13 @@ +# GenerateDescriptionRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_id** | **str** | Identifier of the object to describe | +**object_type** | **str** | Type of the object to describe. One of: visualization, dashboard, metric, fact, 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/GenerateDescriptionResponse.md b/gooddata-api-client/docs/GenerateDescriptionResponse.md new file mode 100644 index 000000000..1836677eb --- /dev/null +++ b/gooddata-api-client/docs/GenerateDescriptionResponse.md @@ -0,0 +1,13 @@ +# GenerateDescriptionResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | Generated description of the requested object | [optional] +**note** | **str** | Additional note with details in case generation was not performed | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/GenerateTitleRequest.md b/gooddata-api-client/docs/GenerateTitleRequest.md new file mode 100644 index 000000000..573beaf60 --- /dev/null +++ b/gooddata-api-client/docs/GenerateTitleRequest.md @@ -0,0 +1,13 @@ +# GenerateTitleRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object_id** | **str** | Identifier of the object to title | +**object_type** | **str** | Type of the object to title. Matches chat-search object types. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/GenerateTitleResponse.md b/gooddata-api-client/docs/GenerateTitleResponse.md new file mode 100644 index 000000000..6d960c5e6 --- /dev/null +++ b/gooddata-api-client/docs/GenerateTitleResponse.md @@ -0,0 +1,13 @@ +# GenerateTitleResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**note** | **str** | Additional note with details in case generation was not performed | [optional] +**title** | **str** | Generated title of the requested 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/GetAiLakeOperation200Response.md b/gooddata-api-client/docs/GetAiLakeOperation200Response.md index a318e6bde..e977824e0 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. | [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. | [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/JsonApiAnalyticalDashboardOutAttributes.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutAttributes.md index f845db7fc..2242a3828 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutAttributes.md @@ -6,6 +6,9 @@ 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] +**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] **description** | **str** | | [optional] **modified_at** | **datetime, none_type** | Time of the last entity modification. | [optional] diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationships.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationships.md index 268c5c89d..dff60916e 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationships.md @@ -5,13 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **analytical_dashboards** | [**JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards**](JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards.md) | | [optional] -**created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] +**certified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy**](JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md) | | [optional] +**created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy**](JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md) | | [optional] **dashboard_plugins** | [**JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins**](JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins.md) | | [optional] **datasets** | [**JsonApiAnalyticalDashboardOutRelationshipsDatasets**](JsonApiAnalyticalDashboardOutRelationshipsDatasets.md) | | [optional] **filter_contexts** | [**JsonApiAnalyticalDashboardOutRelationshipsFilterContexts**](JsonApiAnalyticalDashboardOutRelationshipsFilterContexts.md) | | [optional] **labels** | [**JsonApiAnalyticalDashboardOutRelationshipsLabels**](JsonApiAnalyticalDashboardOutRelationshipsLabels.md) | | [optional] **metrics** | [**JsonApiAnalyticalDashboardOutRelationshipsMetrics**](JsonApiAnalyticalDashboardOutRelationshipsMetrics.md) | | [optional] -**modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] +**modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy**](JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.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] diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md similarity index 90% rename from gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md rename to gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md index 93256df3f..75de4af52 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md @@ -1,4 +1,4 @@ -# JsonApiAnalyticalDashboardOutRelationshipsCreatedBy +# JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy ## Properties diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutRelationships.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutRelationships.md index 4da316af7..e3118acc6 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutRelationships.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAttributeHierarchyOutRelationshipsAttributes**](JsonApiAttributeHierarchyOutRelationshipsAttributes.md) | | [optional] -**created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] -**modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] +**created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy**](JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md) | | [optional] +**modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy**](JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.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/JsonApiAutomationOutRelationships.md b/gooddata-api-client/docs/JsonApiAutomationOutRelationships.md index faec77979..2ed42226a 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutRelationships.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **analytical_dashboard** | [**JsonApiAutomationInRelationshipsAnalyticalDashboard**](JsonApiAutomationInRelationshipsAnalyticalDashboard.md) | | [optional] **automation_results** | [**JsonApiAutomationOutRelationshipsAutomationResults**](JsonApiAutomationOutRelationshipsAutomationResults.md) | | [optional] -**created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] +**created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy**](JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md) | | [optional] **export_definitions** | [**JsonApiAutomationInRelationshipsExportDefinitions**](JsonApiAutomationInRelationshipsExportDefinitions.md) | | [optional] -**modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] +**modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy**](JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md) | | [optional] **notification_channel** | [**JsonApiAutomationInRelationshipsNotificationChannel**](JsonApiAutomationInRelationshipsNotificationChannel.md) | | [optional] **recipients** | [**JsonApiAutomationInRelationshipsRecipients**](JsonApiAutomationInRelationshipsRecipients.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/JsonApiDashboardPluginOutRelationships.md b/gooddata-api-client/docs/JsonApiDashboardPluginOutRelationships.md index 95ca9ce8b..c5767fa81 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginOutRelationships.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] -**modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] +**created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy**](JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md) | | [optional] +**modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy**](JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.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/JsonApiExportDefinitionOutRelationships.md b/gooddata-api-client/docs/JsonApiExportDefinitionOutRelationships.md index 602cbb550..8dbce6fc9 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionOutRelationships.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **analytical_dashboard** | [**JsonApiAutomationInRelationshipsAnalyticalDashboard**](JsonApiAutomationInRelationshipsAnalyticalDashboard.md) | | [optional] **automation** | [**JsonApiAutomationResultOutRelationshipsAutomation**](JsonApiAutomationResultOutRelationshipsAutomation.md) | | [optional] -**created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] -**modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] +**created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy**](JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md) | | [optional] +**modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy**](JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md) | | [optional] **visualization_object** | [**JsonApiExportDefinitionInRelationshipsVisualizationObject**](JsonApiExportDefinitionInRelationshipsVisualizationObject.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/JsonApiLlmProviderIn.md b/gooddata-api-client/docs/JsonApiLlmProviderIn.md new file mode 100644 index 000000000..fa9f062c2 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiLlmProviderIn.md @@ -0,0 +1,15 @@ +# JsonApiLlmProviderIn + +LLM Provider configuration for connecting to LLM services. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiLlmProviderInAttributes**](JsonApiLlmProviderInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "llmProvider" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiLlmProviderInAttributes.md b/gooddata-api-client/docs/JsonApiLlmProviderInAttributes.md new file mode 100644 index 000000000..885d9995d --- /dev/null +++ b/gooddata-api-client/docs/JsonApiLlmProviderInAttributes.md @@ -0,0 +1,16 @@ +# JsonApiLlmProviderInAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**models** | [**[JsonApiLlmProviderInAttributesModelsInner], none_type**](JsonApiLlmProviderInAttributesModelsInner.md) | List of LLM models available for this provider. | +**provider_config** | [**JsonApiLlmProviderInAttributesProviderConfig**](JsonApiLlmProviderInAttributesProviderConfig.md) | | +**default_model_id** | **str, none_type** | ID of the default model to use from the models list. | [optional] +**description** | **str, none_type** | Description of the LLM Provider. | [optional] +**name** | **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/JsonApiLlmProviderInAttributesModelsInner.md b/gooddata-api-client/docs/JsonApiLlmProviderInAttributesModelsInner.md new file mode 100644 index 000000000..d15e8183b --- /dev/null +++ b/gooddata-api-client/docs/JsonApiLlmProviderInAttributesModelsInner.md @@ -0,0 +1,14 @@ +# JsonApiLlmProviderInAttributesModelsInner + +LLM Model configuration (id, family) within a provider. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**family** | **str** | Family of LLM models. | +**id** | **str** | Unique identifier of the model (e.g., gpt-5.3, claude-4.6). | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiLlmProviderInAttributesProviderConfig.md b/gooddata-api-client/docs/JsonApiLlmProviderInAttributesProviderConfig.md new file mode 100644 index 000000000..40e1a6639 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiLlmProviderInAttributesProviderConfig.md @@ -0,0 +1,18 @@ +# JsonApiLlmProviderInAttributesProviderConfig + +Provider-specific configuration including authentication. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**base_url** | **str, none_type** | Custom base URL for OpenAI API. | [optional] if omitted the server will use the default value of "https://api.openai.com" +**organization** | **str, none_type** | OpenAI organization ID. | [optional] +**auth** | [**OpenAiProviderAuth**](OpenAiProviderAuth.md) | | [optional] +**region** | **str** | AWS region for Bedrock. | [optional] +**type** | **str** | Provider type. | [optional] if omitted the server will use the default value of "OPENAI" +**endpoint** | **str** | Azure AI inference endpoint URL. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiLlmProviderInDocument.md b/gooddata-api-client/docs/JsonApiLlmProviderInDocument.md new file mode 100644 index 000000000..a07835e80 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiLlmProviderInDocument.md @@ -0,0 +1,12 @@ +# JsonApiLlmProviderInDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiLlmProviderIn**](JsonApiLlmProviderIn.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/JsonApiLlmProviderOut.md b/gooddata-api-client/docs/JsonApiLlmProviderOut.md new file mode 100644 index 000000000..3c0fa41cf --- /dev/null +++ b/gooddata-api-client/docs/JsonApiLlmProviderOut.md @@ -0,0 +1,15 @@ +# JsonApiLlmProviderOut + +LLM Provider configuration for connecting to LLM services. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiLlmProviderInAttributes**](JsonApiLlmProviderInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "llmProvider" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiLlmProviderOutDocument.md b/gooddata-api-client/docs/JsonApiLlmProviderOutDocument.md new file mode 100644 index 000000000..b8c75d048 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiLlmProviderOutDocument.md @@ -0,0 +1,13 @@ +# JsonApiLlmProviderOutDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiLlmProviderOut**](JsonApiLlmProviderOut.md) | | +**links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiLlmProviderOutList.md b/gooddata-api-client/docs/JsonApiLlmProviderOutList.md new file mode 100644 index 000000000..6939df401 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiLlmProviderOutList.md @@ -0,0 +1,15 @@ +# JsonApiLlmProviderOutList + +A JSON:API document with a list of resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[JsonApiLlmProviderOutWithLinks]**](JsonApiLlmProviderOutWithLinks.md) | | +**links** | [**ListLinks**](ListLinks.md) | | [optional] +**meta** | [**JsonApiAggregatedFactOutListMeta**](JsonApiAggregatedFactOutListMeta.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/JsonApiLlmProviderOutWithLinks.md b/gooddata-api-client/docs/JsonApiLlmProviderOutWithLinks.md new file mode 100644 index 000000000..0e2c3684c --- /dev/null +++ b/gooddata-api-client/docs/JsonApiLlmProviderOutWithLinks.md @@ -0,0 +1,15 @@ +# JsonApiLlmProviderOutWithLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiLlmProviderInAttributes**](JsonApiLlmProviderInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "llmProvider" +**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/JsonApiLlmProviderPatch.md b/gooddata-api-client/docs/JsonApiLlmProviderPatch.md new file mode 100644 index 000000000..3c6b83a09 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiLlmProviderPatch.md @@ -0,0 +1,15 @@ +# JsonApiLlmProviderPatch + +LLM Provider configuration for connecting to LLM services. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiLlmProviderPatchAttributes**](JsonApiLlmProviderPatchAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "llmProvider" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiLlmProviderPatchAttributes.md b/gooddata-api-client/docs/JsonApiLlmProviderPatchAttributes.md new file mode 100644 index 000000000..2d7c3d4a1 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiLlmProviderPatchAttributes.md @@ -0,0 +1,16 @@ +# JsonApiLlmProviderPatchAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**default_model_id** | **str, none_type** | ID of the default model to use from the models list. | [optional] +**description** | **str, none_type** | Description of the LLM Provider. | [optional] +**models** | [**[JsonApiLlmProviderInAttributesModelsInner], none_type**](JsonApiLlmProviderInAttributesModelsInner.md) | List of LLM models available for this provider. | [optional] +**name** | **str, none_type** | | [optional] +**provider_config** | [**JsonApiLlmProviderInAttributesProviderConfig**](JsonApiLlmProviderInAttributesProviderConfig.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/JsonApiLlmProviderPatchDocument.md b/gooddata-api-client/docs/JsonApiLlmProviderPatchDocument.md new file mode 100644 index 000000000..061e8f1f5 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiLlmProviderPatchDocument.md @@ -0,0 +1,12 @@ +# JsonApiLlmProviderPatchDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiLlmProviderPatch**](JsonApiLlmProviderPatch.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/JsonApiMetricOutAttributes.md b/gooddata-api-client/docs/JsonApiMetricOutAttributes.md index 63d76ef31..fb550c7df 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiMetricOutAttributes.md @@ -6,6 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **content** | [**JsonApiMetricInAttributesContent**](JsonApiMetricInAttributesContent.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] **description** | **str** | | [optional] **is_hidden** | **bool** | | [optional] diff --git a/gooddata-api-client/docs/JsonApiMetricOutRelationships.md b/gooddata-api-client/docs/JsonApiMetricOutRelationships.md index 995bc4892..5ee6072a2 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiMetricOutRelationships.md @@ -5,12 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAttributeHierarchyOutRelationshipsAttributes**](JsonApiAttributeHierarchyOutRelationshipsAttributes.md) | | [optional] -**created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] +**certified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy**](JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md) | | [optional] +**created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy**](JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md) | | [optional] **datasets** | [**JsonApiAnalyticalDashboardOutRelationshipsDatasets**](JsonApiAnalyticalDashboardOutRelationshipsDatasets.md) | | [optional] **facts** | [**JsonApiDatasetOutRelationshipsFacts**](JsonApiDatasetOutRelationshipsFacts.md) | | [optional] **labels** | [**JsonApiAnalyticalDashboardOutRelationshipsLabels**](JsonApiAnalyticalDashboardOutRelationshipsLabels.md) | | [optional] **metrics** | [**JsonApiAnalyticalDashboardOutRelationshipsMetrics**](JsonApiAnalyticalDashboardOutRelationshipsMetrics.md) | | [optional] -**modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] +**modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy**](JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.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 3e1da6b2d..75b77ebf6 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectOutAttributes.md @@ -6,6 +6,9 @@ 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] +**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] **description** | **str** | | [optional] **is_hidden** | **bool** | | [optional] diff --git a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutRelationships.md b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutRelationships.md index 5a7432f3c..f0679bc03 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutRelationships.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **analytical_dashboard** | [**JsonApiAutomationInRelationshipsAnalyticalDashboard**](JsonApiAutomationInRelationshipsAnalyticalDashboard.md) | | [optional] **automation_results** | [**JsonApiAutomationOutRelationshipsAutomationResults**](JsonApiAutomationOutRelationshipsAutomationResults.md) | | [optional] -**created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] +**created_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy**](JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md) | | [optional] **export_definitions** | [**JsonApiAutomationInRelationshipsExportDefinitions**](JsonApiAutomationInRelationshipsExportDefinitions.md) | | [optional] -**modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCreatedBy**](JsonApiAnalyticalDashboardOutRelationshipsCreatedBy.md) | | [optional] +**modified_by** | [**JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy**](JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy.md) | | [optional] **notification_channel** | [**JsonApiAutomationInRelationshipsNotificationChannel**](JsonApiAutomationInRelationshipsNotificationChannel.md) | | [optional] **recipients** | [**JsonApiAutomationInRelationshipsRecipients**](JsonApiAutomationInRelationshipsRecipients.md) | | [optional] **workspace** | [**JsonApiWorkspaceAutomationOutRelationshipsWorkspace**](JsonApiWorkspaceAutomationOutRelationshipsWorkspace.md) | | [optional] diff --git a/gooddata-api-client/docs/KnowledgeDocumentMetadataDto.md b/gooddata-api-client/docs/KnowledgeDocumentMetadataDto.md new file mode 100644 index 000000000..506d460bc --- /dev/null +++ b/gooddata-api-client/docs/KnowledgeDocumentMetadataDto.md @@ -0,0 +1,21 @@ +# KnowledgeDocumentMetadataDto + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_at** | **str** | | +**created_by** | **str** | | +**filename** | **str** | | +**num_chunks** | **int** | | +**scopes** | **[str]** | | +**updated_at** | **str** | | +**updated_by** | **str** | | +**is_disabled** | **bool** | | [optional] +**title** | **str** | | [optional] +**workspace_id** | **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/KnowledgeSearchResultDto.md b/gooddata-api-client/docs/KnowledgeSearchResultDto.md new file mode 100644 index 000000000..7e68dddbe --- /dev/null +++ b/gooddata-api-client/docs/KnowledgeSearchResultDto.md @@ -0,0 +1,20 @@ +# KnowledgeSearchResultDto + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**chunk_index** | **int** | | +**content** | **str** | | +**filename** | **str** | | +**page_numbers** | **[int]** | | +**scopes** | **[str]** | | +**score** | **float** | | +**total_chunks** | **int** | | +**title** | **str** | | [optional] +**workspace_id** | **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/LLMEndpointsApi.md b/gooddata-api-client/docs/LLMEndpointsApi.md index 31a56d9d6..e81130cf2 100644 --- a/gooddata-api-client/docs/LLMEndpointsApi.md +++ b/gooddata-api-client/docs/LLMEndpointsApi.md @@ -116,7 +116,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = llm_endpoints_api.LLMEndpointsApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: @@ -187,7 +187,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = llm_endpoints_api.LLMEndpointsApi(api_client) - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 = [ @@ -266,7 +266,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = llm_endpoints_api.LLMEndpointsApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: @@ -357,7 +357,7 @@ with gooddata_api_client.ApiClient() as api_client: type="llmEndpoint", ), ) # JsonApiLlmEndpointPatchDocument | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: @@ -449,7 +449,7 @@ with gooddata_api_client.ApiClient() as api_client: type="llmEndpoint", ), ) # JsonApiLlmEndpointInDocument | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: diff --git a/gooddata-api-client/docs/LLMProvidersApi.md b/gooddata-api-client/docs/LLMProvidersApi.md new file mode 100644 index 000000000..fc7558260 --- /dev/null +++ b/gooddata-api-client/docs/LLMProvidersApi.md @@ -0,0 +1,518 @@ +# gooddata_api_client.LLMProvidersApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_llm_providers**](LLMProvidersApi.md#create_entity_llm_providers) | **POST** /api/v1/entities/llmProviders | Post LLM Provider entities +[**delete_entity_llm_providers**](LLMProvidersApi.md#delete_entity_llm_providers) | **DELETE** /api/v1/entities/llmProviders/{id} | Delete LLM Provider entity +[**get_all_entities_llm_providers**](LLMProvidersApi.md#get_all_entities_llm_providers) | **GET** /api/v1/entities/llmProviders | Get all LLM Provider entities +[**get_entity_llm_providers**](LLMProvidersApi.md#get_entity_llm_providers) | **GET** /api/v1/entities/llmProviders/{id} | Get LLM Provider entity +[**patch_entity_llm_providers**](LLMProvidersApi.md#patch_entity_llm_providers) | **PATCH** /api/v1/entities/llmProviders/{id} | Patch LLM Provider entity +[**update_entity_llm_providers**](LLMProvidersApi.md#update_entity_llm_providers) | **PUT** /api/v1/entities/llmProviders/{id} | PUT LLM Provider entity + + +# **create_entity_llm_providers** +> JsonApiLlmProviderOutDocument create_entity_llm_providers(json_api_llm_provider_in_document) + +Post LLM Provider entities + +LLM Provider - connection configuration for LLM services + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import llm_providers_api +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument +from gooddata_api_client.model.json_api_llm_provider_in_document import JsonApiLlmProviderInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = llm_providers_api.LLMProvidersApi(api_client) + json_api_llm_provider_in_document = JsonApiLlmProviderInDocument( + data=JsonApiLlmProviderIn( + 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(None), + ), + id="id1", + type="llmProvider", + ), + ) # JsonApiLlmProviderInDocument | + + # example passing only required values which don't have defaults set + try: + # Post LLM Provider entities + api_response = api_instance.create_entity_llm_providers(json_api_llm_provider_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->create_entity_llm_providers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **json_api_llm_provider_in_document** | [**JsonApiLlmProviderInDocument**](JsonApiLlmProviderInDocument.md)| | + +### Return type + +[**JsonApiLlmProviderOutDocument**](JsonApiLlmProviderOutDocument.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_llm_providers** +> delete_entity_llm_providers(id) + +Delete LLM Provider entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import llm_providers_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 = llm_providers_api.LLMProvidersApi(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) + + # example passing only required values which don't have defaults set + try: + # Delete LLM Provider entity + api_instance.delete_entity_llm_providers(id) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->delete_entity_llm_providers: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete LLM Provider entity + api_instance.delete_entity_llm_providers(id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->delete_entity_llm_providers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +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_llm_providers** +> JsonApiLlmProviderOutList get_all_entities_llm_providers() + +Get all LLM Provider entities + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import llm_providers_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = llm_providers_api.LLMProvidersApi(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) + 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 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 LLMProvidersApi->get_all_entities_llm_providers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiLlmProviderOutList**](JsonApiLlmProviderOutList.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_llm_providers** +> JsonApiLlmProviderOutDocument get_entity_llm_providers(id) + +Get LLM Provider entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import llm_providers_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = llm_providers_api.LLMProvidersApi(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) + + # 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) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->get_entity_llm_providers: %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) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->get_entity_llm_providers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiLlmProviderOutDocument**](JsonApiLlmProviderOutDocument.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_llm_providers** +> JsonApiLlmProviderOutDocument patch_entity_llm_providers(id, json_api_llm_provider_patch_document) + +Patch LLM Provider entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import llm_providers_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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = llm_providers_api.LLMProvidersApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_llm_provider_patch_document = JsonApiLlmProviderPatchDocument( + data=JsonApiLlmProviderPatch( + attributes=JsonApiLlmProviderPatchAttributes( + default_model_id="default_model_id_example", + description="description_example", + models=[ + JsonApiLlmProviderInAttributesModelsInner( + family="OPENAI", + id="id_example", + ), + ], + name="name_example", + provider_config=JsonApiLlmProviderInAttributesProviderConfig(None), + ), + id="id1", + type="llmProvider", + ), + ) # 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 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 LLMProvidersApi->patch_entity_llm_providers: %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) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->patch_entity_llm_providers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **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 + +[**JsonApiLlmProviderOutDocument**](JsonApiLlmProviderOutDocument.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_llm_providers** +> JsonApiLlmProviderOutDocument update_entity_llm_providers(id, json_api_llm_provider_in_document) + +PUT LLM Provider entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import llm_providers_api +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument +from gooddata_api_client.model.json_api_llm_provider_in_document import JsonApiLlmProviderInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = llm_providers_api.LLMProvidersApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_llm_provider_in_document = JsonApiLlmProviderInDocument( + data=JsonApiLlmProviderIn( + 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(None), + ), + id="id1", + type="llmProvider", + ), + ) # JsonApiLlmProviderInDocument | + 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: + # PUT LLM Provider entity + api_response = api_instance.update_entity_llm_providers(id, json_api_llm_provider_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->update_entity_llm_providers: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # PUT LLM Provider entity + api_response = api_instance.update_entity_llm_providers(id, json_api_llm_provider_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->update_entity_llm_providers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_llm_provider_in_document** | [**JsonApiLlmProviderInDocument**](JsonApiLlmProviderInDocument.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) + +### 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/LayoutApi.md b/gooddata-api-client/docs/LayoutApi.md index 31aabbfe3..d8986cb7d 100644 --- a/gooddata-api-client/docs/LayoutApi.md +++ b/gooddata-api-client/docs/LayoutApi.md @@ -2005,6 +2005,13 @@ with gooddata_api_client.ApiClient() as api_client: ], analytical_dashboards=[ DeclarativeAnalyticalDashboard( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -2029,14 +2036,14 @@ with gooddata_api_client.ApiClient() as api_client: attribute_hierarchies=[ DeclarativeAttributeHierarchy( content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Simple number for total goods in current production.", id="hierarchy-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -2048,14 +2055,14 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_plugins=[ DeclarativeDashboardPlugin( content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Three dimensional view of data.", id="dashboard-plugin-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -2066,14 +2073,14 @@ with gooddata_api_client.ApiClient() as api_client: ], export_definitions=[ DeclarativeExportDefinition( - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Simple number for total goods in current production.", id="export-definition-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -2118,8 +2125,15 @@ with gooddata_api_client.ApiClient() as api_client: ], metrics=[ DeclarativeMetric( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -2128,7 +2142,7 @@ with gooddata_api_client.ApiClient() as api_client: id="total-sales", is_hidden=False, is_hidden_from_kda=False, - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -2139,8 +2153,15 @@ with gooddata_api_client.ApiClient() as api_client: ], visualization_objects=[ DeclarativeVisualizationObject( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -2148,7 +2169,7 @@ with gooddata_api_client.ApiClient() as api_client: description="Simple number for total goods in current production.", id="visualization-1", is_hidden=False, - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -2414,6 +2435,13 @@ with gooddata_api_client.ApiClient() as api_client: ], analytical_dashboards=[ DeclarativeAnalyticalDashboard( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -2438,14 +2466,14 @@ with gooddata_api_client.ApiClient() as api_client: attribute_hierarchies=[ DeclarativeAttributeHierarchy( content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Simple number for total goods in current production.", id="hierarchy-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -2457,14 +2485,14 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_plugins=[ DeclarativeDashboardPlugin( content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Three dimensional view of data.", id="dashboard-plugin-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -2475,14 +2503,14 @@ with gooddata_api_client.ApiClient() as api_client: ], export_definitions=[ DeclarativeExportDefinition( - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Simple number for total goods in current production.", id="export-definition-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -2527,8 +2555,15 @@ with gooddata_api_client.ApiClient() as api_client: ], metrics=[ DeclarativeMetric( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -2537,7 +2572,7 @@ with gooddata_api_client.ApiClient() as api_client: id="total-sales", is_hidden=False, is_hidden_from_kda=False, - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -2548,8 +2583,15 @@ with gooddata_api_client.ApiClient() as api_client: ], visualization_objects=[ DeclarativeVisualizationObject( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -2557,7 +2599,7 @@ with gooddata_api_client.ApiClient() as api_client: description="Simple number for total goods in current production.", id="visualization-1", is_hidden=False, - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -2784,6 +2826,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -4195,6 +4252,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -4367,6 +4439,13 @@ with gooddata_api_client.ApiClient() as api_client: ], analytical_dashboards=[ DeclarativeAnalyticalDashboard( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -4391,14 +4470,14 @@ with gooddata_api_client.ApiClient() as api_client: attribute_hierarchies=[ DeclarativeAttributeHierarchy( content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Simple number for total goods in current production.", id="hierarchy-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -4410,14 +4489,14 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_plugins=[ DeclarativeDashboardPlugin( content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Three dimensional view of data.", id="dashboard-plugin-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -4428,14 +4507,14 @@ with gooddata_api_client.ApiClient() as api_client: ], export_definitions=[ DeclarativeExportDefinition( - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Simple number for total goods in current production.", id="export-definition-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -4480,8 +4559,15 @@ with gooddata_api_client.ApiClient() as api_client: ], metrics=[ DeclarativeMetric( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -4490,7 +4576,7 @@ with gooddata_api_client.ApiClient() as api_client: id="total-sales", is_hidden=False, is_hidden_from_kda=False, - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -4501,8 +4587,15 @@ with gooddata_api_client.ApiClient() as api_client: ], visualization_objects=[ DeclarativeVisualizationObject( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -4510,7 +4603,7 @@ with gooddata_api_client.ApiClient() as api_client: description="Simple number for total goods in current production.", id="visualization-1", is_hidden=False, - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -5474,6 +5567,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -5646,6 +5754,13 @@ with gooddata_api_client.ApiClient() as api_client: ], analytical_dashboards=[ DeclarativeAnalyticalDashboard( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -5670,14 +5785,14 @@ with gooddata_api_client.ApiClient() as api_client: attribute_hierarchies=[ DeclarativeAttributeHierarchy( content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Simple number for total goods in current production.", id="hierarchy-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -5689,14 +5804,14 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_plugins=[ DeclarativeDashboardPlugin( content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Three dimensional view of data.", id="dashboard-plugin-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -5707,14 +5822,14 @@ with gooddata_api_client.ApiClient() as api_client: ], export_definitions=[ DeclarativeExportDefinition( - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Simple number for total goods in current production.", id="export-definition-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -5759,8 +5874,15 @@ with gooddata_api_client.ApiClient() as api_client: ], metrics=[ DeclarativeMetric( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -5769,7 +5891,7 @@ with gooddata_api_client.ApiClient() as api_client: id="total-sales", is_hidden=False, is_hidden_from_kda=False, - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -5780,8 +5902,15 @@ with gooddata_api_client.ApiClient() as api_client: ], visualization_objects=[ DeclarativeVisualizationObject( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -5789,7 +5918,7 @@ with gooddata_api_client.ApiClient() as api_client: description="Simple number for total goods in current production.", id="visualization-1", is_hidden=False, - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", diff --git a/gooddata-api-client/docs/ListKnowledgeDocumentsResponseDto.md b/gooddata-api-client/docs/ListKnowledgeDocumentsResponseDto.md new file mode 100644 index 000000000..4098dc245 --- /dev/null +++ b/gooddata-api-client/docs/ListKnowledgeDocumentsResponseDto.md @@ -0,0 +1,14 @@ +# ListKnowledgeDocumentsResponseDto + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**documents** | [**[KnowledgeDocumentMetadataDto]**](KnowledgeDocumentMetadataDto.md) | | +**next_page_token** | **str** | | [optional] +**total_count** | **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/LlmModel.md b/gooddata-api-client/docs/LlmModel.md new file mode 100644 index 000000000..acec0a1e7 --- /dev/null +++ b/gooddata-api-client/docs/LlmModel.md @@ -0,0 +1,14 @@ +# LlmModel + +LLM Model configuration (id, family) within a provider. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**family** | **str** | Family of LLM models. | +**id** | **str** | Unique identifier of the model (e.g., gpt-5.3, claude-4.6). | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/LlmProviderAuth.md b/gooddata-api-client/docs/LlmProviderAuth.md new file mode 100644 index 000000000..814d9fd14 --- /dev/null +++ b/gooddata-api-client/docs/LlmProviderAuth.md @@ -0,0 +1,12 @@ +# LlmProviderAuth + + +## 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/LlmProviderConfig.md b/gooddata-api-client/docs/LlmProviderConfig.md new file mode 100644 index 000000000..9ce5198f8 --- /dev/null +++ b/gooddata-api-client/docs/LlmProviderConfig.md @@ -0,0 +1,18 @@ +# LlmProviderConfig + +Provider configuration to test. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**base_url** | **str, none_type** | Custom base URL for OpenAI API. | [optional] if omitted the server will use the default value of "https://api.openai.com" +**organization** | **str, none_type** | OpenAI organization ID. | [optional] +**auth** | [**OpenAiProviderAuth**](OpenAiProviderAuth.md) | | [optional] +**region** | **str** | AWS region for Bedrock. | [optional] +**type** | **str** | Provider type. | [optional] if omitted the server will use the default value of "OPENAI" +**endpoint** | **str** | Azure AI inference endpoint URL. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/MetricDefinitionOverride.md b/gooddata-api-client/docs/MetricDefinitionOverride.md new file mode 100644 index 000000000..899acb22c --- /dev/null +++ b/gooddata-api-client/docs/MetricDefinitionOverride.md @@ -0,0 +1,14 @@ +# MetricDefinitionOverride + +(EXPERIMENTAL) Override for a catalog metric definition. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**definition** | [**InlineMeasureDefinition**](InlineMeasureDefinition.md) | | +**item** | [**AfmObjectIdentifierCore**](AfmObjectIdentifierCore.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/MetricsApi.md b/gooddata-api-client/docs/MetricsApi.md index 045dedafb..18eddb5b3 100644 --- a/gooddata-api-client/docs/MetricsApi.md +++ b/gooddata-api-client/docs/MetricsApi.md @@ -62,7 +62,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiMetricPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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", @@ -222,7 +222,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 @@ -318,7 +318,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 = [ @@ -428,7 +428,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 @@ -632,7 +632,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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/ModelTestResult.md b/gooddata-api-client/docs/ModelTestResult.md new file mode 100644 index 000000000..58ad0349e --- /dev/null +++ b/gooddata-api-client/docs/ModelTestResult.md @@ -0,0 +1,15 @@ +# ModelTestResult + +Per-model test results. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | Message about the model test result. | +**model_id** | **str** | The model ID that was tested. | +**successful** | **bool** | Whether the model test was successful. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/OpenAIProviderConfig.md b/gooddata-api-client/docs/OpenAIProviderConfig.md new file mode 100644 index 000000000..aa6fa09ae --- /dev/null +++ b/gooddata-api-client/docs/OpenAIProviderConfig.md @@ -0,0 +1,16 @@ +# OpenAIProviderConfig + +Configuration for OpenAI provider. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**auth** | [**OpenAiProviderAuth**](OpenAiProviderAuth.md) | | +**type** | **str** | Provider type. | defaults to "OPENAI" +**base_url** | **str, none_type** | Custom base URL for OpenAI API. | [optional] if omitted the server will use the default value of "https://api.openai.com" +**organization** | **str, none_type** | OpenAI organization 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/OpenAiApiKeyAuth.md b/gooddata-api-client/docs/OpenAiApiKeyAuth.md new file mode 100644 index 000000000..64cdbd71b --- /dev/null +++ b/gooddata-api-client/docs/OpenAiApiKeyAuth.md @@ -0,0 +1,13 @@ +# OpenAiApiKeyAuth + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Authentication type. | defaults to "API_KEY" +**api_key** | **str, none_type** | OpenAI API key. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/OpenAiApiKeyAuthAllOf.md b/gooddata-api-client/docs/OpenAiApiKeyAuthAllOf.md new file mode 100644 index 000000000..248605c56 --- /dev/null +++ b/gooddata-api-client/docs/OpenAiApiKeyAuthAllOf.md @@ -0,0 +1,13 @@ +# OpenAiApiKeyAuthAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**api_key** | **str, none_type** | OpenAI API key. | [optional] +**type** | **str** | Authentication type. | [optional] if omitted the server will use the default value of "API_KEY" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/OpenAiProviderAuth.md b/gooddata-api-client/docs/OpenAiProviderAuth.md new file mode 100644 index 000000000..7ac39a634 --- /dev/null +++ b/gooddata-api-client/docs/OpenAiProviderAuth.md @@ -0,0 +1,14 @@ +# OpenAiProviderAuth + +Authentication configuration. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**api_key** | **str, none_type** | OpenAI API key. | [optional] +**type** | **str** | Authentication type. | [optional] if omitted the server will use the default value of "API_KEY" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/Operation.md b/gooddata-api-client/docs/Operation.md index 7ef5c6987..0cee4f156 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. | +**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. | **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 943241de0..48d280bbe 100644 --- a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md @@ -687,6 +687,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -859,6 +874,13 @@ with gooddata_api_client.ApiClient() as api_client: ], analytical_dashboards=[ DeclarativeAnalyticalDashboard( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -883,14 +905,14 @@ with gooddata_api_client.ApiClient() as api_client: attribute_hierarchies=[ DeclarativeAttributeHierarchy( content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Simple number for total goods in current production.", id="hierarchy-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -902,14 +924,14 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_plugins=[ DeclarativeDashboardPlugin( content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Three dimensional view of data.", id="dashboard-plugin-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -920,14 +942,14 @@ with gooddata_api_client.ApiClient() as api_client: ], export_definitions=[ DeclarativeExportDefinition( - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Simple number for total goods in current production.", id="export-definition-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -972,8 +994,15 @@ with gooddata_api_client.ApiClient() as api_client: ], metrics=[ DeclarativeMetric( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -982,7 +1011,7 @@ with gooddata_api_client.ApiClient() as api_client: id="total-sales", is_hidden=False, is_hidden_from_kda=False, - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -993,8 +1022,15 @@ with gooddata_api_client.ApiClient() as api_client: ], visualization_objects=[ DeclarativeVisualizationObject( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -1002,7 +1038,7 @@ with gooddata_api_client.ApiClient() as api_client: description="Simple number for total goods in current production.", id="visualization-1", is_hidden=False, - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", diff --git a/gooddata-api-client/docs/OrganizationModelControllerApi.md b/gooddata-api-client/docs/OrganizationModelControllerApi.md index a2abc8a40..ef07ba041 100644 --- a/gooddata-api-client/docs/OrganizationModelControllerApi.md +++ b/gooddata-api-client/docs/OrganizationModelControllerApi.md @@ -12,6 +12,7 @@ Method | HTTP request | Description [**create_entity_identity_providers**](OrganizationModelControllerApi.md#create_entity_identity_providers) | **POST** /api/v1/entities/identityProviders | Post Identity Providers [**create_entity_jwks**](OrganizationModelControllerApi.md#create_entity_jwks) | **POST** /api/v1/entities/jwks | Post Jwks [**create_entity_llm_endpoints**](OrganizationModelControllerApi.md#create_entity_llm_endpoints) | **POST** /api/v1/entities/llmEndpoints | Post LLM endpoint entities +[**create_entity_llm_providers**](OrganizationModelControllerApi.md#create_entity_llm_providers) | **POST** /api/v1/entities/llmProviders | Post LLM Provider entities [**create_entity_notification_channels**](OrganizationModelControllerApi.md#create_entity_notification_channels) | **POST** /api/v1/entities/notificationChannels | Post Notification Channel entities [**create_entity_organization_settings**](OrganizationModelControllerApi.md#create_entity_organization_settings) | **POST** /api/v1/entities/organizationSettings | Post Organization Setting entities [**create_entity_themes**](OrganizationModelControllerApi.md#create_entity_themes) | **POST** /api/v1/entities/themes | Post Theming @@ -26,6 +27,7 @@ Method | HTTP request | Description [**delete_entity_identity_providers**](OrganizationModelControllerApi.md#delete_entity_identity_providers) | **DELETE** /api/v1/entities/identityProviders/{id} | Delete Identity Provider [**delete_entity_jwks**](OrganizationModelControllerApi.md#delete_entity_jwks) | **DELETE** /api/v1/entities/jwks/{id} | Delete Jwk [**delete_entity_llm_endpoints**](OrganizationModelControllerApi.md#delete_entity_llm_endpoints) | **DELETE** /api/v1/entities/llmEndpoints/{id} | +[**delete_entity_llm_providers**](OrganizationModelControllerApi.md#delete_entity_llm_providers) | **DELETE** /api/v1/entities/llmProviders/{id} | Delete LLM Provider entity [**delete_entity_notification_channels**](OrganizationModelControllerApi.md#delete_entity_notification_channels) | **DELETE** /api/v1/entities/notificationChannels/{id} | Delete Notification Channel entity [**delete_entity_organization_settings**](OrganizationModelControllerApi.md#delete_entity_organization_settings) | **DELETE** /api/v1/entities/organizationSettings/{id} | Delete Organization entity [**delete_entity_themes**](OrganizationModelControllerApi.md#delete_entity_themes) | **DELETE** /api/v1/entities/themes/{id} | Delete Theming @@ -42,6 +44,7 @@ Method | HTTP request | Description [**get_all_entities_identity_providers**](OrganizationModelControllerApi.md#get_all_entities_identity_providers) | **GET** /api/v1/entities/identityProviders | Get all Identity Providers [**get_all_entities_jwks**](OrganizationModelControllerApi.md#get_all_entities_jwks) | **GET** /api/v1/entities/jwks | Get all Jwks [**get_all_entities_llm_endpoints**](OrganizationModelControllerApi.md#get_all_entities_llm_endpoints) | **GET** /api/v1/entities/llmEndpoints | Get all LLM endpoint entities +[**get_all_entities_llm_providers**](OrganizationModelControllerApi.md#get_all_entities_llm_providers) | **GET** /api/v1/entities/llmProviders | Get all LLM Provider entities [**get_all_entities_notification_channel_identifiers**](OrganizationModelControllerApi.md#get_all_entities_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers | [**get_all_entities_notification_channels**](OrganizationModelControllerApi.md#get_all_entities_notification_channels) | **GET** /api/v1/entities/notificationChannels | Get all Notification Channel entities [**get_all_entities_organization_settings**](OrganizationModelControllerApi.md#get_all_entities_organization_settings) | **GET** /api/v1/entities/organizationSettings | Get Organization entities @@ -60,6 +63,7 @@ Method | HTTP request | Description [**get_entity_identity_providers**](OrganizationModelControllerApi.md#get_entity_identity_providers) | **GET** /api/v1/entities/identityProviders/{id} | Get Identity Provider [**get_entity_jwks**](OrganizationModelControllerApi.md#get_entity_jwks) | **GET** /api/v1/entities/jwks/{id} | Get Jwk [**get_entity_llm_endpoints**](OrganizationModelControllerApi.md#get_entity_llm_endpoints) | **GET** /api/v1/entities/llmEndpoints/{id} | Get LLM endpoint entity +[**get_entity_llm_providers**](OrganizationModelControllerApi.md#get_entity_llm_providers) | **GET** /api/v1/entities/llmProviders/{id} | Get LLM Provider entity [**get_entity_notification_channel_identifiers**](OrganizationModelControllerApi.md#get_entity_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers/{id} | [**get_entity_notification_channels**](OrganizationModelControllerApi.md#get_entity_notification_channels) | **GET** /api/v1/entities/notificationChannels/{id} | Get Notification Channel entity [**get_entity_organization_settings**](OrganizationModelControllerApi.md#get_entity_organization_settings) | **GET** /api/v1/entities/organizationSettings/{id} | Get Organization entity @@ -76,6 +80,7 @@ Method | HTTP request | Description [**patch_entity_identity_providers**](OrganizationModelControllerApi.md#patch_entity_identity_providers) | **PATCH** /api/v1/entities/identityProviders/{id} | Patch Identity Provider [**patch_entity_jwks**](OrganizationModelControllerApi.md#patch_entity_jwks) | **PATCH** /api/v1/entities/jwks/{id} | Patch Jwk [**patch_entity_llm_endpoints**](OrganizationModelControllerApi.md#patch_entity_llm_endpoints) | **PATCH** /api/v1/entities/llmEndpoints/{id} | Patch LLM endpoint entity +[**patch_entity_llm_providers**](OrganizationModelControllerApi.md#patch_entity_llm_providers) | **PATCH** /api/v1/entities/llmProviders/{id} | Patch LLM Provider entity [**patch_entity_notification_channels**](OrganizationModelControllerApi.md#patch_entity_notification_channels) | **PATCH** /api/v1/entities/notificationChannels/{id} | Patch Notification Channel entity [**patch_entity_organization_settings**](OrganizationModelControllerApi.md#patch_entity_organization_settings) | **PATCH** /api/v1/entities/organizationSettings/{id} | Patch Organization entity [**patch_entity_themes**](OrganizationModelControllerApi.md#patch_entity_themes) | **PATCH** /api/v1/entities/themes/{id} | Patch Theming @@ -90,6 +95,7 @@ Method | HTTP request | Description [**update_entity_identity_providers**](OrganizationModelControllerApi.md#update_entity_identity_providers) | **PUT** /api/v1/entities/identityProviders/{id} | Put Identity Provider [**update_entity_jwks**](OrganizationModelControllerApi.md#update_entity_jwks) | **PUT** /api/v1/entities/jwks/{id} | Put Jwk [**update_entity_llm_endpoints**](OrganizationModelControllerApi.md#update_entity_llm_endpoints) | **PUT** /api/v1/entities/llmEndpoints/{id} | PUT LLM endpoint entity +[**update_entity_llm_providers**](OrganizationModelControllerApi.md#update_entity_llm_providers) | **PUT** /api/v1/entities/llmProviders/{id} | PUT LLM Provider entity [**update_entity_notification_channels**](OrganizationModelControllerApi.md#update_entity_notification_channels) | **PUT** /api/v1/entities/notificationChannels/{id} | Put Notification Channel entity [**update_entity_organization_settings**](OrganizationModelControllerApi.md#update_entity_organization_settings) | **PUT** /api/v1/entities/organizationSettings/{id} | Put Organization entity [**update_entity_themes**](OrganizationModelControllerApi.md#update_entity_themes) | **PUT** /api/v1/entities/themes/{id} | Put Theming @@ -810,6 +816,91 @@ 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_llm_providers** +> JsonApiLlmProviderOutDocument create_entity_llm_providers(json_api_llm_provider_in_document) + +Post LLM Provider entities + +LLM Provider - connection configuration for LLM services + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument +from gooddata_api_client.model.json_api_llm_provider_in_document import JsonApiLlmProviderInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) + json_api_llm_provider_in_document = JsonApiLlmProviderInDocument( + data=JsonApiLlmProviderIn( + 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(None), + ), + id="id1", + type="llmProvider", + ), + ) # JsonApiLlmProviderInDocument | + + # example passing only required values which don't have defaults set + try: + # Post LLM Provider entities + api_response = api_instance.create_entity_llm_providers(json_api_llm_provider_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->create_entity_llm_providers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **json_api_llm_provider_in_document** | [**JsonApiLlmProviderInDocument**](JsonApiLlmProviderInDocument.md)| | + +### Return type + +[**JsonApiLlmProviderOutDocument**](JsonApiLlmProviderOutDocument.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 | @@ -1901,7 +1992,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: @@ -1918,6 +2009,79 @@ with gooddata_api_client.ApiClient() as api_client: ``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +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_llm_providers** +> delete_entity_llm_providers(id) + +Delete LLM Provider entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import organization_model_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 = organization_model_controller_api.OrganizationModelControllerApi(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) + + # example passing only required values which don't have defaults set + try: + # Delete LLM Provider entity + api_instance.delete_entity_llm_providers(id) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->delete_entity_llm_providers: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete LLM Provider entity + api_instance.delete_entity_llm_providers(id, filter=filter) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->delete_entity_llm_providers: %s\n" % e) +``` + + ### Parameters Name | Type | Description | Notes @@ -3125,7 +3289,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 = [ @@ -3170,6 +3334,84 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_llm_providers** +> JsonApiLlmProviderOutList get_all_entities_llm_providers() + +Get all LLM Provider entities + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import organization_model_controller_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = organization_model_controller_api.OrganizationModelControllerApi(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) + 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 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 OrganizationModelControllerApi->get_all_entities_llm_providers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiLlmProviderOutList**](JsonApiLlmProviderOutList.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 | @@ -4545,7 +4787,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: @@ -4587,6 +4829,82 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_llm_providers** +> JsonApiLlmProviderOutDocument get_entity_llm_providers(id) + +Get LLM Provider entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import organization_model_controller_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = organization_model_controller_api.OrganizationModelControllerApi(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) + + # 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) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->get_entity_llm_providers: %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) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->get_entity_llm_providers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiLlmProviderOutDocument**](JsonApiLlmProviderOutDocument.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 | @@ -5984,7 +6302,7 @@ with gooddata_api_client.ApiClient() as api_client: type="llmEndpoint", ), ) # JsonApiLlmEndpointPatchDocument | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: @@ -6027,6 +6345,102 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_llm_providers** +> JsonApiLlmProviderOutDocument patch_entity_llm_providers(id, json_api_llm_provider_patch_document) + +Patch LLM Provider entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import organization_model_controller_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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_llm_provider_patch_document = JsonApiLlmProviderPatchDocument( + data=JsonApiLlmProviderPatch( + attributes=JsonApiLlmProviderPatchAttributes( + default_model_id="default_model_id_example", + description="description_example", + models=[ + JsonApiLlmProviderInAttributesModelsInner( + family="OPENAI", + id="id_example", + ), + ], + name="name_example", + provider_config=JsonApiLlmProviderInAttributesProviderConfig(None), + ), + id="id1", + type="llmProvider", + ), + ) # 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 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 OrganizationModelControllerApi->patch_entity_llm_providers: %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) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->patch_entity_llm_providers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **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 + +[**JsonApiLlmProviderOutDocument**](JsonApiLlmProviderOutDocument.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 | @@ -7384,7 +7798,7 @@ with gooddata_api_client.ApiClient() as api_client: type="llmEndpoint", ), ) # JsonApiLlmEndpointInDocument | - filter = "title==someString;provider==LLMProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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;provider==LlmEndpointProviderValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: @@ -7427,6 +7841,102 @@ 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_llm_providers** +> JsonApiLlmProviderOutDocument update_entity_llm_providers(id, json_api_llm_provider_in_document) + +PUT LLM Provider entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import organization_model_controller_api +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument +from gooddata_api_client.model.json_api_llm_provider_in_document import JsonApiLlmProviderInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = organization_model_controller_api.OrganizationModelControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_llm_provider_in_document = JsonApiLlmProviderInDocument( + data=JsonApiLlmProviderIn( + 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(None), + ), + id="id1", + type="llmProvider", + ), + ) # JsonApiLlmProviderInDocument | + 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: + # PUT LLM Provider entity + api_response = api_instance.update_entity_llm_providers(id, json_api_llm_provider_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->update_entity_llm_providers: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # PUT LLM Provider entity + api_response = api_instance.update_entity_llm_providers(id, json_api_llm_provider_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationModelControllerApi->update_entity_llm_providers: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_llm_provider_in_document** | [**JsonApiLlmProviderInDocument**](JsonApiLlmProviderInDocument.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) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/PatchKnowledgeDocumentRequestDto.md b/gooddata-api-client/docs/PatchKnowledgeDocumentRequestDto.md new file mode 100644 index 000000000..3e39d120e --- /dev/null +++ b/gooddata-api-client/docs/PatchKnowledgeDocumentRequestDto.md @@ -0,0 +1,14 @@ +# PatchKnowledgeDocumentRequestDto + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**is_disabled** | **bool** | | [optional] +**scopes** | **[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/PendingOperation.md b/gooddata-api-client/docs/PendingOperation.md index d025e7e8c..28320905a 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. | +**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. | **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/RawExportApi.md b/gooddata-api-client/docs/RawExportApi.md index ef80b5781..96c1b06ad 100644 --- a/gooddata-api-client/docs/RawExportApi.md +++ b/gooddata-api-client/docs/RawExportApi.md @@ -73,6 +73,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), diff --git a/gooddata-api-client/docs/RelativeDateFilterRelativeDateFilter.md b/gooddata-api-client/docs/RelativeDateFilterRelativeDateFilter.md index eca210716..91a8d7079 100644 --- a/gooddata-api-client/docs/RelativeDateFilterRelativeDateFilter.md +++ b/gooddata-api-client/docs/RelativeDateFilterRelativeDateFilter.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **to** | **int** | 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, ...). | **apply_on_result** | **bool** | | [optional] **bounded_filter** | [**BoundedFilter**](BoundedFilter.md) | | [optional] +**empty_value_handling** | **str** | Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates. | [optional] if omitted the server will use the default value of "EXCLUDE" **local_identifier** | **str** | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/RunServiceCommandRequest.md b/gooddata-api-client/docs/RunServiceCommandRequest.md new file mode 100644 index 000000000..134111da3 --- /dev/null +++ b/gooddata-api-client/docs/RunServiceCommandRequest.md @@ -0,0 +1,14 @@ +# RunServiceCommandRequest + +Request to run an AI Lake Service Command + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**context** | **{str: (str, none_type)}, none_type** | The context to pass to the command | [optional] +**payload** | [**JsonNode**](JsonNode.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/SearchKnowledgeResponseDto.md b/gooddata-api-client/docs/SearchKnowledgeResponseDto.md new file mode 100644 index 000000000..939d9f028 --- /dev/null +++ b/gooddata-api-client/docs/SearchKnowledgeResponseDto.md @@ -0,0 +1,13 @@ +# SearchKnowledgeResponseDto + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | [**[KnowledgeSearchResultDto]**](KnowledgeSearchResultDto.md) | | +**statistics** | [**SearchStatisticsDto**](SearchStatisticsDto.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/SearchStatisticsDto.md b/gooddata-api-client/docs/SearchStatisticsDto.md new file mode 100644 index 000000000..def7dbf8d --- /dev/null +++ b/gooddata-api-client/docs/SearchStatisticsDto.md @@ -0,0 +1,13 @@ +# SearchStatisticsDto + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**average_similarity_score** | **float** | | +**total_results** | **int** | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ServiceInfo.md b/gooddata-api-client/docs/ServiceInfo.md new file mode 100644 index 000000000..14500d661 --- /dev/null +++ b/gooddata-api-client/docs/ServiceInfo.md @@ -0,0 +1,14 @@ +# ServiceInfo + +Non-sensitive metadata for an AI Lake pipeline + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Human-readable name of the service | +**service_id** | **str** | Internal identifier for the service configuration (UUID) | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/SetCertificationRequest.md b/gooddata-api-client/docs/SetCertificationRequest.md new file mode 100644 index 000000000..d88fac78a --- /dev/null +++ b/gooddata-api-client/docs/SetCertificationRequest.md @@ -0,0 +1,16 @@ +# SetCertificationRequest + +Request to set or clear the certification of a workspace entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the entity. | +**type** | **str** | Type of the entity. | +**message** | **str, none_type** | Optional message associated with the certification. | [optional] +**status** | **str, none_type** | Certification status of the entity. | [optional] if omitted the server will use the default value of "CERTIFIED" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-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 d1d7e2e81..ad6b146b9 100644 --- a/gooddata-api-client/docs/SmartFunctionsApi.md +++ b/gooddata-api-client/docs/SmartFunctionsApi.md @@ -16,11 +16,15 @@ Method | HTTP request | Description [**created_by**](SmartFunctionsApi.md#created_by) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy | Get Analytics Catalog CreatedBy Users [**forecast**](SmartFunctionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | (BETA) Smart functions - Forecast [**forecast_result**](SmartFunctionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | (BETA) Smart functions - Forecast Result +[**generate_description**](SmartFunctionsApi.md#generate_description) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateDescription | Generate Description for Analytics Object +[**generate_title**](SmartFunctionsApi.md#generate_title) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateTitle | Generate Title for Analytics Object [**get_quality_issues**](SmartFunctionsApi.md#get_quality_issues) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues | Get Quality Issues [**get_quality_issues_calculation_status**](SmartFunctionsApi.md#get_quality_issues_calculation_status) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId} | Get Quality Issues Calculation Status [**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 [**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 [**trigger_quality_issues_calculation**](SmartFunctionsApi.md#trigger_quality_issues_calculation) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck | Trigger Quality Issues Calculation [**validate_llm_endpoint**](SmartFunctionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/llmEndpoint/test | Validate LLM Endpoint [**validate_llm_endpoint_by_id**](SmartFunctionsApi.md#validate_llm_endpoint_by_id) | **POST** /api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test | Validate LLM Endpoint By Id @@ -1024,6 +1028,152 @@ 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_description** +> GenerateDescriptionResponse generate_description(workspace_id, generate_description_request) + +Generate Description for Analytics Object + +Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import smart_functions_api +from gooddata_api_client.model.generate_description_request import GenerateDescriptionRequest +from gooddata_api_client.model.generate_description_response import GenerateDescriptionResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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 + generate_description_request = GenerateDescriptionRequest( + object_id="object_id_example", + object_type="Visualization", + ) # GenerateDescriptionRequest | + + # example passing only required values which don't have defaults set + try: + # Generate Description for Analytics Object + api_response = api_instance.generate_description(workspace_id, generate_description_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->generate_description: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **generate_description_request** | [**GenerateDescriptionRequest**](GenerateDescriptionRequest.md)| | + +### Return type + +[**GenerateDescriptionResponse**](GenerateDescriptionResponse.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) + +# **generate_title** +> GenerateTitleResponse generate_title(workspace_id, generate_title_request) + +Generate Title for Analytics Object + +Generates a title for the specified analytics object. Returns title and a note with details if generation was not performed. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import smart_functions_api +from gooddata_api_client.model.generate_title_request import GenerateTitleRequest +from gooddata_api_client.model.generate_title_response import GenerateTitleResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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 + generate_title_request = GenerateTitleRequest( + object_id="object_id_example", + object_type="Visualization", + ) # GenerateTitleRequest | + + # example passing only required values which don't have defaults set + try: + # Generate Title for Analytics Object + api_response = api_instance.generate_title(workspace_id, generate_title_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->generate_title: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **generate_title_request** | [**GenerateTitleRequest**](GenerateTitleRequest.md)| | + +### Return type + +[**GenerateTitleResponse**](GenerateTitleResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | @@ -1361,6 +1511,149 @@ 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) + +# **test_llm_provider** +> TestLlmProviderResponse test_llm_provider(test_llm_provider_definition_request) + +Test LLM Provider + +Tests LLM provider connectivity with a full definition. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import smart_functions_api +from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse +from gooddata_api_client.model.test_llm_provider_definition_request import TestLlmProviderDefinitionRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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) + test_llm_provider_definition_request = TestLlmProviderDefinitionRequest( + models=[ + LlmModel( + family="OPENAI", + id="id_example", + ), + ], + provider_config=TestLlmProviderDefinitionRequestProviderConfig(None), + ) # TestLlmProviderDefinitionRequest | + + # example passing only required values which don't have defaults set + try: + # Test LLM Provider + api_response = api_instance.test_llm_provider(test_llm_provider_definition_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->test_llm_provider: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **test_llm_provider_definition_request** | [**TestLlmProviderDefinitionRequest**](TestLlmProviderDefinitionRequest.md)| | + +### Return type + +[**TestLlmProviderResponse**](TestLlmProviderResponse.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) + +# **test_llm_provider_by_id** +> TestLlmProviderResponse test_llm_provider_by_id(llm_provider_id) + +Test LLM Provider By Id + +Tests an existing LLM provider connectivity by its ID. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import smart_functions_api +from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context 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) + llm_provider_id = "llmProviderId_example" # str | + + # example passing only required values which don't have defaults set + try: + # Test LLM Provider By Id + api_response = api_instance.test_llm_provider_by_id(llm_provider_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->test_llm_provider_by_id: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **llm_provider_id** | **str**| | + +### Return type + +[**TestLlmProviderResponse**](TestLlmProviderResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/SucceededOperation.md b/gooddata-api-client/docs/SucceededOperation.md index cad6b1b9c..90b88c13c 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. | +**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. | **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] **any string name** | **bool, 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/TestLlmProviderDefinitionRequest.md b/gooddata-api-client/docs/TestLlmProviderDefinitionRequest.md new file mode 100644 index 000000000..3045f7af8 --- /dev/null +++ b/gooddata-api-client/docs/TestLlmProviderDefinitionRequest.md @@ -0,0 +1,13 @@ +# TestLlmProviderDefinitionRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**provider_config** | [**TestLlmProviderDefinitionRequestProviderConfig**](TestLlmProviderDefinitionRequestProviderConfig.md) | | +**models** | [**[LlmModel]**](LlmModel.md) | Models to test. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/TestLlmProviderDefinitionRequestProviderConfig.md b/gooddata-api-client/docs/TestLlmProviderDefinitionRequestProviderConfig.md new file mode 100644 index 000000000..d28dabb8d --- /dev/null +++ b/gooddata-api-client/docs/TestLlmProviderDefinitionRequestProviderConfig.md @@ -0,0 +1,17 @@ +# TestLlmProviderDefinitionRequestProviderConfig + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**base_url** | **str, none_type** | Custom base URL for OpenAI API. | [optional] if omitted the server will use the default value of "https://api.openai.com" +**organization** | **str, none_type** | OpenAI organization ID. | [optional] +**auth** | [**OpenAiProviderAuth**](OpenAiProviderAuth.md) | | [optional] +**region** | **str** | AWS region for Bedrock. | [optional] +**type** | **str** | Provider type. | [optional] if omitted the server will use the default value of "OPENAI" +**endpoint** | **str** | Azure AI inference endpoint URL. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/TestLlmProviderResponse.md b/gooddata-api-client/docs/TestLlmProviderResponse.md new file mode 100644 index 000000000..c61fc81da --- /dev/null +++ b/gooddata-api-client/docs/TestLlmProviderResponse.md @@ -0,0 +1,14 @@ +# TestLlmProviderResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**model_results** | [**[ModelTestResult]**](ModelTestResult.md) | Per-model test results. | +**provider_message** | **str** | Message about the provider connectivity test. | +**provider_reachable** | **bool** | Whether the LLM provider is reachable. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/UpsertKnowledgeDocumentRequestDto.md b/gooddata-api-client/docs/UpsertKnowledgeDocumentRequestDto.md new file mode 100644 index 000000000..9b3b3d247 --- /dev/null +++ b/gooddata-api-client/docs/UpsertKnowledgeDocumentRequestDto.md @@ -0,0 +1,16 @@ +# UpsertKnowledgeDocumentRequestDto + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | **str** | | +**filename** | **str** | | +**page_boundaries** | **[int]** | | [optional] +**scopes** | **[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/UpsertKnowledgeDocumentResponseDto.md b/gooddata-api-client/docs/UpsertKnowledgeDocumentResponseDto.md new file mode 100644 index 000000000..c9f448fd7 --- /dev/null +++ b/gooddata-api-client/docs/UpsertKnowledgeDocumentResponseDto.md @@ -0,0 +1,15 @@ +# UpsertKnowledgeDocumentResponseDto + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filename** | **str** | | +**message** | **str** | | +**num_chunks** | **int** | | +**success** | **bool** | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/VisualizationConfig.md b/gooddata-api-client/docs/VisualizationConfig.md new file mode 100644 index 000000000..18e35d64b --- /dev/null +++ b/gooddata-api-client/docs/VisualizationConfig.md @@ -0,0 +1,16 @@ +# VisualizationConfig + +Visualization config for smart-function rendering. + +## 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] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-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 0568dec14..c18722af1 100644 --- a/gooddata-api-client/docs/VisualizationObjectApi.md +++ b/gooddata-api-client/docs/VisualizationObjectApi.md @@ -57,7 +57,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiVisualizationObjectPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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", @@ -217,7 +217,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 @@ -313,7 +313,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 = [ @@ -418,7 +418,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 @@ -617,7 +617,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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/WhatIfMeasureAdjustmentConfig.md b/gooddata-api-client/docs/WhatIfMeasureAdjustmentConfig.md new file mode 100644 index 000000000..9022aa476 --- /dev/null +++ b/gooddata-api-client/docs/WhatIfMeasureAdjustmentConfig.md @@ -0,0 +1,15 @@ +# 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 new file mode 100644 index 000000000..d0dc7963f --- /dev/null +++ b/gooddata-api-client/docs/WhatIfScenarioConfig.md @@ -0,0 +1,14 @@ +# 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 new file mode 100644 index 000000000..f292bafb7 --- /dev/null +++ b/gooddata-api-client/docs/WhatIfScenarioItem.md @@ -0,0 +1,14 @@ +# 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/WorkspaceObjectControllerApi.md b/gooddata-api-client/docs/WorkspaceObjectControllerApi.md index ff12c7c23..e914a559c 100644 --- a/gooddata-api-client/docs/WorkspaceObjectControllerApi.md +++ b/gooddata-api-client/docs/WorkspaceObjectControllerApi.md @@ -182,7 +182,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiAnalyticalDashboardPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,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) meta_include = [ "metaInclude=permissions,origin,accessInfo,all", @@ -488,6 +488,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -1444,7 +1459,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiMetricPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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", @@ -1651,7 +1666,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiVisualizationObjectPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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", @@ -3323,7 +3338,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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,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 @@ -4659,7 +4674,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 @@ -4851,7 +4866,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 @@ -5317,7 +5332,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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ @@ -6537,7 +6552,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 = [ @@ -6713,7 +6728,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 = [ @@ -7078,7 +7093,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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,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) # example passing only required values which don't have defaults set @@ -7485,6 +7500,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -8737,7 +8767,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 @@ -8944,7 +8974,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 @@ -11515,7 +11545,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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,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) # example passing only required values which don't have defaults set @@ -11820,6 +11850,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -12781,7 +12826,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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 @@ -12988,7 +13033,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,facts,attributes,labels,metrics,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,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/WorkspacesDeclarativeAPIsApi.md b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md index e0a2d41c1..a700e3ff5 100644 --- a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md @@ -200,6 +200,13 @@ with gooddata_api_client.ApiClient() as api_client: ], analytical_dashboards=[ DeclarativeAnalyticalDashboard( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -224,14 +231,14 @@ with gooddata_api_client.ApiClient() as api_client: attribute_hierarchies=[ DeclarativeAttributeHierarchy( content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Simple number for total goods in current production.", id="hierarchy-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -243,14 +250,14 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_plugins=[ DeclarativeDashboardPlugin( content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Three dimensional view of data.", id="dashboard-plugin-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -261,14 +268,14 @@ with gooddata_api_client.ApiClient() as api_client: ], export_definitions=[ DeclarativeExportDefinition( - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Simple number for total goods in current production.", id="export-definition-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -313,8 +320,15 @@ with gooddata_api_client.ApiClient() as api_client: ], metrics=[ DeclarativeMetric( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -323,7 +337,7 @@ with gooddata_api_client.ApiClient() as api_client: id="total-sales", is_hidden=False, is_hidden_from_kda=False, - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -334,8 +348,15 @@ with gooddata_api_client.ApiClient() as api_client: ], visualization_objects=[ DeclarativeVisualizationObject( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -343,7 +364,7 @@ with gooddata_api_client.ApiClient() as api_client: description="Simple number for total goods in current production.", id="visualization-1", is_hidden=False, - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -772,6 +793,21 @@ with gooddata_api_client.ApiClient() as api_client: filters=[ FilterDefinition(), ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=InlineMeasureDefinitionInline( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=AfmObjectIdentifierCoreIdentifier( + id="sample_item.price", + type="attribute", + ), + ), + ), + ], measures=[ MeasureItem( definition=MeasureDefinition(), @@ -944,6 +980,13 @@ with gooddata_api_client.ApiClient() as api_client: ], analytical_dashboards=[ DeclarativeAnalyticalDashboard( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -968,14 +1011,14 @@ with gooddata_api_client.ApiClient() as api_client: attribute_hierarchies=[ DeclarativeAttributeHierarchy( content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Simple number for total goods in current production.", id="hierarchy-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -987,14 +1030,14 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_plugins=[ DeclarativeDashboardPlugin( content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Three dimensional view of data.", id="dashboard-plugin-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -1005,14 +1048,14 @@ with gooddata_api_client.ApiClient() as api_client: ], export_definitions=[ DeclarativeExportDefinition( - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", ), description="Simple number for total goods in current production.", id="export-definition-1", - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -1057,8 +1100,15 @@ with gooddata_api_client.ApiClient() as api_client: ], metrics=[ DeclarativeMetric( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -1067,7 +1117,7 @@ with gooddata_api_client.ApiClient() as api_client: id="total-sales", is_hidden=False, is_hidden_from_kda=False, - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -1078,8 +1128,15 @@ with gooddata_api_client.ApiClient() as api_client: ], visualization_objects=[ DeclarativeVisualizationObject( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), content=JsonNode(), - created_at="["2023-07-20 12:30"]", + created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", type="user", @@ -1087,7 +1144,7 @@ with gooddata_api_client.ApiClient() as api_client: description="Simple number for total goods in current production.", id="visualization-1", is_hidden=False, - modified_at="["2023-07-20 12:30"]", + modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", type="user", diff --git a/gooddata-api-client/docs/apis/tags/AACAnalyticsModelApi.md b/gooddata-api-client/docs/apis/tags/AACAnalyticsModelApi.md new file mode 100644 index 000000000..f1551efc2 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/AACAnalyticsModelApi.md @@ -0,0 +1,357 @@ + +# gooddata_api_client.apis.tags.aac_analytics_model_api.AACAnalyticsModelApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_analytics_model_aac**](#get_analytics_model_aac) | **get** /api/v1/aac/workspaces/{workspaceId}/analyticsModel | Get analytics model in AAC format +[**set_analytics_model_aac**](#set_analytics_model_aac) | **put** /api/v1/aac/workspaces/{workspaceId}/analyticsModel | Set analytics model from AAC format + +# **get_analytics_model_aac** + +> AacAnalyticsModel get_analytics_model_aac(workspace_id) + +Get analytics model in AAC format + + Retrieve the analytics model of the workspace in Analytics as Code format. The returned format is compatible with the YAML definitions used by the GoodData Analytics as Code VSCode extension. This includes metrics, dashboards, visualizations, plugins, and attribute hierarchies. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import aac_analytics_model_api +from gooddata_api_client.model.aac_analytics_model import AacAnalyticsModel +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = aac_analytics_model_api.AACAnalyticsModelApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + try: + # Get analytics model in AAC format + api_response = api_instance.get_analytics_model_aac( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AACAnalyticsModelApi->get_analytics_model_aac: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'exclude': [ + "ACTIVITY_INFO" + ], + } + try: + # Get analytics model in AAC format + api_response = api_instance.get_analytics_model_aac( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AACAnalyticsModelApi->get_analytics_model_aac: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +exclude | ExcludeSchema | | optional + + +# ExcludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Defines properties which should not be included in the payload. | must be one of ["ACTIVITY_INFO", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_analytics_model_aac.ApiResponseFor200) | Retrieved current analytics model in AAC format. + +#### get_analytics_model_aac.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**AacAnalyticsModel**](../../models/AacAnalyticsModel.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **set_analytics_model_aac** + +> set_analytics_model_aac(workspace_idaac_analytics_model) + +Set analytics model from AAC format + + Set the analytics model of the workspace using Analytics as Code format. The input format is compatible with the YAML definitions used by the GoodData Analytics as Code VSCode extension. This replaces the entire analytics model with the provided definition, including metrics, dashboards, visualizations, plugins, and attribute hierarchies. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import aac_analytics_model_api +from gooddata_api_client.model.aac_analytics_model import AacAnalyticsModel +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = aac_analytics_model_api.AACAnalyticsModelApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = AacAnalyticsModel( + attribute_hierarchies=[ + AacAttributeHierarchy( + attributes=["attribute/country","attribute/state","attribute/city"], + description="description_example", + id="geo-hierarchy", + tags=[ + "tags_example" + ], + title="Geographic Hierarchy", + type="attribute_hierarchy", + ) + ], + dashboards=[ + AacDashboard(None) + ], + metrics=[ + AacMetric( + description="description_example", + format="#,##0.00", + id="total-sales", + is_hidden=True, + is_hidden_from_kda=True, + maql="SELECT SUM({fact/amount})", + show_in_ai_results=True, +, + title="Total Sales", + type="metric", + ) + ], + plugins=[ + AacPlugin( + description="description_example", + id="my-plugin", +, + title="My Plugin", + type="plugin", + url="https://example.com/plugin.js", + ) + ], + visualizations=[ + AacVisualization( + additional_properties=dict( + "key": JsonNode(), + ), + attributes=[ + None + ], + columns=[], + config=JsonNode(), + description="description_example", + _from=JsonNode(), + id="sales-by-region", + is_hidden=True, + layers=[ + AacVisualizationLayer( + additional_properties=dict(), + config=JsonNode(), + filters=dict( + "key": AacQueryFilter( + additional_properties=dict(), + attribute="attribute_example", + bottom=1, + condition="condition_example", + dimensionality=[ + "dimensionality_example" + ], + display_as="display_as_example", + _from=None, + granularity="granularity_example", + null_values_as_zero=True, + state=AacFilterState( + exclude=[ + "exclude_example" + ], + include=[ + "include_example" + ], + ), +, + top=1, + type="date_filter", + using="using_example", + value=3.14, + ), + ), + id="id_example", + metrics=[], + segment_by=[], + sorts=[ + JsonNode() + ], + title="title_example", + type="pushpin", + view_by=[], + ) + ], + metrics=[], + query=AacQuery( + fields=dict( +, + ), + filter_by=dict( + "key": AacQueryFilter(), + ), + sort_by=[ + JsonNode() + ], + ), + rows=[], + segment_by=[], + show_in_ai_results=True, + size_by=[], + stack_by=[], +, + title="Sales by Region", + to=JsonNode(), + trend_by=[], + type="AacVisualizationBasicBuckets", + view_by=[], + ) + ], + ) + try: + # Set analytics model from AAC format + api_response = api_instance.set_analytics_model_aac( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AACAnalyticsModelApi->set_analytics_model_aac: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**AacAnalyticsModel**](../../models/AacAnalyticsModel.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#set_analytics_model_aac.ApiResponseFor204) | Analytics model successfully set. + +#### set_analytics_model_aac.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/AACLogicalDataModelApi.md b/gooddata-api-client/docs/apis/tags/AACLogicalDataModelApi.md new file mode 100644 index 000000000..69d720e43 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/AACLogicalDataModelApi.md @@ -0,0 +1,322 @@ + +# gooddata_api_client.apis.tags.aac_logical_data_model_api.AACLogicalDataModelApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_logical_model_aac**](#get_logical_model_aac) | **get** /api/v1/aac/workspaces/{workspaceId}/logicalModel | Get logical model in AAC format +[**set_logical_model_aac**](#set_logical_model_aac) | **put** /api/v1/aac/workspaces/{workspaceId}/logicalModel | Set logical model from AAC format + +# **get_logical_model_aac** + +> AacLogicalModel get_logical_model_aac(workspace_id) + +Get logical model in AAC format + + Retrieve the logical data model of the workspace in Analytics as Code format. The returned format is compatible with the YAML definitions used by the GoodData Analytics as Code VSCode extension. Use this for exporting models that can be directly used as YAML configuration files. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import aac_logical_data_model_api +from gooddata_api_client.model.aac_logical_model import AacLogicalModel +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = aac_logical_data_model_api.AACLogicalDataModelApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + try: + # Get logical model in AAC format + api_response = api_instance.get_logical_model_aac( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AACLogicalDataModelApi->get_logical_model_aac: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'includeParents': True, + } + try: + # Get logical model in AAC format + api_response = api_instance.get_logical_model_aac( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AACLogicalDataModelApi->get_logical_model_aac: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +includeParents | IncludeParentsSchema | | optional + + +# IncludeParentsSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_logical_model_aac.ApiResponseFor200) | Retrieved current logical model in AAC format. + +#### get_logical_model_aac.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**AacLogicalModel**](../../models/AacLogicalModel.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **set_logical_model_aac** + +> set_logical_model_aac(workspace_idaac_logical_model) + +Set logical model from AAC format + + Set the logical data model of the workspace using Analytics as Code format. The input format is compatible with the YAML definitions used by the GoodData Analytics as Code VSCode extension. This replaces the entire logical model with the provided definition. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import aac_logical_data_model_api +from gooddata_api_client.model.aac_logical_model import AacLogicalModel +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = aac_logical_data_model_api.AACLogicalDataModelApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = AacLogicalModel( + datasets=[ + AacDataset( + data_source="my-postgres", + description="description_example", + fields=dict( + "key": AacField( + aggregated_as="SUM", + assigned_to="assigned_to_example", + data_type="STRING", + default_view="default_view_example", + description="description_example", + is_hidden=True, + labels=dict( + "key": AacLabel( + data_type="INT", + description="description_example", + geo_area_config=AacGeoAreaConfig( + collection=AacGeoCollectionIdentifier( + id="id_example", + kind="STATIC", + ), + ), + is_hidden=True, + locale="locale_example", + show_in_ai_results=True, + source_column="source_column_example", + tags=[ + "tags_example" + ], + title="title_example", + translations=[ + AacLabelTranslation( + locale="locale_example", + source_column="source_column_example", + ) + ], + value_type="TEXT", + ), + ), + locale="locale_example", + show_in_ai_results=True, + sort_column="sort_column_example", + sort_direction="ASC", + source_column="source_column_example", +, + title="title_example", + type="attribute", + ), + ), + id="customers", + precedence=1, + primary_key=None, + references=[ + AacReference( + dataset="orders", + multi_directional=True, + sources=[ + AacReferenceSource( + data_type="INT", + source_column="source_column_example", + target="target_example", + ) + ], + ) + ], + sql="sql_example", + table_path="public/customers", +, + title="Customers", + type="dataset", + workspace_data_filters=[ + AacWorkspaceDataFilter( + data_type="INT", + filter_id="filter_id_example", + source_column="source_column_example", + ) + ], + ) + ], + date_datasets=[ + AacDateDataset( + description="description_example", + granularities=[ + "granularities_example" + ], + id="date", +, + title="Date", + title_base="title_base_example", + title_pattern="title_pattern_example", + type="date", + ) + ], + ) + try: + # Set logical model from AAC format + api_response = api_instance.set_logical_model_aac( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AACLogicalDataModelApi->set_logical_model_aac: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**AacLogicalModel**](../../models/AacLogicalModel.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#set_logical_model_aac.ApiResponseFor204) | Logical model successfully set. + +#### set_logical_model_aac.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/AIApi.md b/gooddata-api-client/docs/apis/tags/AIApi.md new file mode 100644 index 000000000..9156ee1ba --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/AIApi.md @@ -0,0 +1,3065 @@ + +# gooddata_api_client.apis.tags.ai_api.AIApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_knowledge_recommendations**](#create_entity_knowledge_recommendations) | **post** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | +[**create_entity_memory_items**](#create_entity_memory_items) | **post** /api/v1/entities/workspaces/{workspaceId}/memoryItems | +[**delete_entity_knowledge_recommendations**](#delete_entity_knowledge_recommendations) | **delete** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | +[**delete_entity_memory_items**](#delete_entity_memory_items) | **delete** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | +[**get_all_entities_knowledge_recommendations**](#get_all_entities_knowledge_recommendations) | **get** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | +[**get_all_entities_memory_items**](#get_all_entities_memory_items) | **get** /api/v1/entities/workspaces/{workspaceId}/memoryItems | +[**get_entity_knowledge_recommendations**](#get_entity_knowledge_recommendations) | **get** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | +[**get_entity_memory_items**](#get_entity_memory_items) | **get** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | +[**metadata_check_organization**](#metadata_check_organization) | **post** /api/v1/actions/organization/metadataCheck | (BETA) Check Organization Metadata Inconsistencies +[**metadata_sync**](#metadata_sync) | **post** /api/v1/actions/workspaces/{workspaceId}/metadataSync | (BETA) Sync Metadata to other services +[**metadata_sync_organization**](#metadata_sync_organization) | **post** /api/v1/actions/organization/metadataSync | (BETA) Sync organization scope Metadata to other services +[**patch_entity_knowledge_recommendations**](#patch_entity_knowledge_recommendations) | **patch** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | +[**patch_entity_memory_items**](#patch_entity_memory_items) | **patch** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | +[**search_entities_knowledge_recommendations**](#search_entities_knowledge_recommendations) | **post** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | +[**search_entities_memory_items**](#search_entities_memory_items) | **post** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | Search request for MemoryItem +[**update_entity_knowledge_recommendations**](#update_entity_knowledge_recommendations) | **put** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | +[**update_entity_memory_items**](#update_entity_memory_items) | **put** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | + +# **create_entity_knowledge_recommendations** + +> JsonApiKnowledgeRecommendationOutDocument create_entity_knowledge_recommendations(workspace_idjson_api_knowledge_recommendation_post_optional_id_document) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags 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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + body = JsonApiKnowledgeRecommendationPostOptionalIdDocument( + data=JsonApiKnowledgeRecommendationPostOptionalId( + attributes=dict( + 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=dict(), + 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=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + metric=dict( + data=JsonApiMetricToOneLinkage(None), + ), + ), + type="knowledgeRecommendation", + ), + ) + try: + api_response = api_instance.create_entity_knowledge_recommendations( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->create_entity_knowledge_recommendations: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'include': [ + "metric,analyticalDashboard" + ], + 'metaInclude': [ + "metaInclude=origin,all" + ], + } + body = JsonApiKnowledgeRecommendationPostOptionalIdDocument( + data=JsonApiKnowledgeRecommendationPostOptionalId( + attributes=dict( + 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=dict(), + 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=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + metric=dict( + data=JsonApiMetricToOneLinkage(None), + ), + ), + type="knowledgeRecommendation", + ), + ) + try: + api_response = api_instance.create_entity_knowledge_recommendations( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->create_entity_knowledge_recommendations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationPostOptionalIdDocument**](../../models/JsonApiKnowledgeRecommendationPostOptionalIdDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationPostOptionalIdDocument**](../../models/JsonApiKnowledgeRecommendationPostOptionalIdDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +include | IncludeSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["metrics", "analyticalDashboards", "metric", "analyticalDashboard", "ALL", ] + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "all", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_entity_knowledge_recommendations.ApiResponseFor201) | Request successfully processed + +#### create_entity_knowledge_recommendations.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, SchemaFor201ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationOutDocument**](../../models/JsonApiKnowledgeRecommendationOutDocument.md) | | + + +# SchemaFor201ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationOutDocument**](../../models/JsonApiKnowledgeRecommendationOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idjson_api_memory_item_post_optional_id_document) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags 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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + body = JsonApiMemoryItemPostOptionalIdDocument( + data=JsonApiMemoryItemPostOptionalId( + attributes=dict( + 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", + ), + ) + try: + api_response = api_instance.create_entity_memory_items( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->create_entity_memory_items: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'include': [ + "createdBy,modifiedBy" + ], + 'metaInclude': [ + "metaInclude=origin,all" + ], + } + body = JsonApiMemoryItemPostOptionalIdDocument( + data=JsonApiMemoryItemPostOptionalId( + attributes=dict( + 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", + ), + ) + try: + api_response = api_instance.create_entity_memory_items( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->create_entity_memory_items: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemPostOptionalIdDocument**](../../models/JsonApiMemoryItemPostOptionalIdDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemPostOptionalIdDocument**](../../models/JsonApiMemoryItemPostOptionalIdDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +include | IncludeSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["userIdentifiers", "createdBy", "modifiedBy", "ALL", ] + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "all", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_entity_memory_items.ApiResponseFor201) | Request successfully processed + +#### create_entity_memory_items.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, SchemaFor201ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemOutDocument**](../../models/JsonApiMemoryItemOutDocument.md) | | + + +# SchemaFor201ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemOutDocument**](../../models/JsonApiMemoryItemOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_id) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import ai_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = ai_api.AIApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + try: + api_response = api_instance.delete_entity_knowledge_recommendations( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->delete_entity_knowledge_recommendations: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + } + try: + api_response = api_instance.delete_entity_knowledge_recommendations( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->delete_entity_knowledge_recommendations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_entity_knowledge_recommendations.ApiResponseFor204) | Successfully deleted + +#### delete_entity_knowledge_recommendations.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_id) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import ai_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = ai_api.AIApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + try: + api_response = api_instance.delete_entity_memory_items( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->delete_entity_memory_items: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + } + try: + api_response = api_instance.delete_entity_memory_items( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->delete_entity_memory_items: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_entity_memory_items.ApiResponseFor204) | Successfully deleted + +#### delete_entity_memory_items.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import ai_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(configuration) as api_client: + # Create an instance of the API class + api_instance = ai_api.AIApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + header_params = { + } + try: + api_response = api_instance.get_all_entities_knowledge_recommendations( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->get_all_entities_knowledge_recommendations: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'origin': "ALL", + 'filter': "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + 'include': [ + "metric,analyticalDashboard" + ], + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=origin,page,all" + ], + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + try: + api_response = api_instance.get_all_entities_knowledge_recommendations( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->get_all_entities_knowledge_recommendations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +origin | OriginSchema | | optional +filter | FilterSchema | | optional +include | IncludeSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# OriginSchema + +Defines scope of origin of objects. All by default. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Defines scope of origin of objects. All by default. | must be one of ["ALL", "PARENTS", "NATIVE", ] if omitted the server will use the default value of "ALL" + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["metrics", "analyticalDashboards", "metric", "analyticalDashboard", "ALL", ] + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "page", "all", "ALL", ] + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_entities_knowledge_recommendations.ApiResponseFor200) | Request successfully processed + +#### get_all_entities_knowledge_recommendations.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationOutList**](../../models/JsonApiKnowledgeRecommendationOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationOutList**](../../models/JsonApiKnowledgeRecommendationOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import ai_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(configuration) as api_client: + # Create an instance of the API class + api_instance = ai_api.AIApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + header_params = { + } + try: + api_response = api_instance.get_all_entities_memory_items( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->get_all_entities_memory_items: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'origin': "ALL", + 'filter': "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + 'include': [ + "createdBy,modifiedBy" + ], + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=origin,page,all" + ], + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + try: + api_response = api_instance.get_all_entities_memory_items( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->get_all_entities_memory_items: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +origin | OriginSchema | | optional +filter | FilterSchema | | optional +include | IncludeSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# OriginSchema + +Defines scope of origin of objects. All by default. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Defines scope of origin of objects. All by default. | must be one of ["ALL", "PARENTS", "NATIVE", ] if omitted the server will use the default value of "ALL" + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["userIdentifiers", "createdBy", "modifiedBy", "ALL", ] + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "page", "all", "ALL", ] + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_entities_memory_items.ApiResponseFor200) | Request successfully processed + +#### get_all_entities_memory_items.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemOutList**](../../models/JsonApiMemoryItemOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemOutList**](../../models/JsonApiMemoryItemOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_id) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import ai_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(configuration) as api_client: + # Create an instance of the API class + api_instance = ai_api.AIApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + header_params = { + } + try: + api_response = api_instance.get_entity_knowledge_recommendations( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->get_entity_knowledge_recommendations: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + 'include': [ + "metric,analyticalDashboard" + ], + 'metaInclude': [ + "metaInclude=origin,all" + ], + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + try: + api_response = api_instance.get_entity_knowledge_recommendations( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->get_entity_knowledge_recommendations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["metrics", "analyticalDashboards", "metric", "analyticalDashboard", "ALL", ] + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "all", "ALL", ] + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_entity_knowledge_recommendations.ApiResponseFor200) | Request successfully processed + +#### get_entity_knowledge_recommendations.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationOutDocument**](../../models/JsonApiKnowledgeRecommendationOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationOutDocument**](../../models/JsonApiKnowledgeRecommendationOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_id) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import ai_api +from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + header_params = { + } + try: + api_response = api_instance.get_entity_memory_items( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->get_entity_memory_items: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + 'include': [ + "createdBy,modifiedBy" + ], + 'metaInclude': [ + "metaInclude=origin,all" + ], + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + try: + api_response = api_instance.get_entity_memory_items( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->get_entity_memory_items: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["userIdentifiers", "createdBy", "modifiedBy", "ALL", ] + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "all", "ALL", ] + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_entity_memory_items.ApiResponseFor200) | Request successfully processed + +#### get_entity_memory_items.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemOutDocument**](../../models/JsonApiMemoryItemOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemOutDocument**](../../models/JsonApiMemoryItemOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **metadata_check_organization** + +> metadata_check_organization() + +(BETA) Check Organization Metadata Inconsistencies + +(BETA) Temporary solution. Resyncs all organization objects and full workspaces within the organization with target GEN_AI_CHECK. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import ai_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = ai_api.AIApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # (BETA) Check Organization Metadata Inconsistencies + api_response = api_instance.metadata_check_organization() + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->metadata_check_organization: %s\n" % e) +``` +### Parameters +This endpoint does not need any parameter. + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#metadata_check_organization.ApiResponseFor200) | OK + +#### metadata_check_organization.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **metadata_sync** + +> metadata_sync(workspace_id) + +(BETA) Sync Metadata to other services + +(BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import ai_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = ai_api.AIApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + try: + # (BETA) Sync Metadata to other services + api_response = api_instance.metadata_sync( + path_params=path_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->metadata_sync: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#metadata_sync.ApiResponseFor200) | OK + +#### metadata_sync.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **metadata_sync_organization** + +> metadata_sync_organization() + +(BETA) Sync organization scope Metadata to other services + +(BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import ai_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = ai_api.AIApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # (BETA) Sync organization scope Metadata to other services + api_response = api_instance.metadata_sync_organization() + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->metadata_sync_organization: %s\n" % e) +``` +### Parameters +This endpoint does not need any parameter. + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#metadata_sync_organization.ApiResponseFor200) | OK + +#### metadata_sync_organization.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_idjson_api_knowledge_recommendation_patch_document) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags 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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + body = JsonApiKnowledgeRecommendationPatchDocument( + data=JsonApiKnowledgeRecommendationPatch( + attributes=dict( + 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=dict(), + 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=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + metric=dict( + data=JsonApiMetricToOneLinkage(None), + ), + ), + type="knowledgeRecommendation", + ), + ) + try: + api_response = api_instance.patch_entity_knowledge_recommendations( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->patch_entity_knowledge_recommendations: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + 'include': [ + "metric,analyticalDashboard" + ], + } + body = JsonApiKnowledgeRecommendationPatchDocument( + data=JsonApiKnowledgeRecommendationPatch( + attributes=dict( + 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=dict(), + 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=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + metric=dict( + data=JsonApiMetricToOneLinkage(None), + ), + ), + type="knowledgeRecommendation", + ), + ) + try: + api_response = api_instance.patch_entity_knowledge_recommendations( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->patch_entity_knowledge_recommendations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationPatchDocument**](../../models/JsonApiKnowledgeRecommendationPatchDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationPatchDocument**](../../models/JsonApiKnowledgeRecommendationPatchDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["metrics", "analyticalDashboards", "metric", "analyticalDashboard", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#patch_entity_knowledge_recommendations.ApiResponseFor200) | Request successfully processed + +#### patch_entity_knowledge_recommendations.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationOutDocument**](../../models/JsonApiKnowledgeRecommendationOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationOutDocument**](../../models/JsonApiKnowledgeRecommendationOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_idjson_api_memory_item_patch_document) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags 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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + body = JsonApiMemoryItemPatchDocument( + data=JsonApiMemoryItemPatch( + attributes=dict( + 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", + ), + ) + try: + api_response = api_instance.patch_entity_memory_items( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->patch_entity_memory_items: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + 'include': [ + "createdBy,modifiedBy" + ], + } + body = JsonApiMemoryItemPatchDocument( + data=JsonApiMemoryItemPatch( + attributes=dict( + 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", + ), + ) + try: + api_response = api_instance.patch_entity_memory_items( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->patch_entity_memory_items: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemPatchDocument**](../../models/JsonApiMemoryItemPatchDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemPatchDocument**](../../models/JsonApiMemoryItemPatchDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["userIdentifiers", "createdBy", "modifiedBy", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#patch_entity_memory_items.ApiResponseFor200) | Request successfully processed + +#### patch_entity_memory_items.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemOutDocument**](../../models/JsonApiMemoryItemOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemOutDocument**](../../models/JsonApiMemoryItemOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_identity_search_body) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags 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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + header_params = { + } + 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", + ) + ], + ) + try: + api_response = api_instance.search_entities_knowledge_recommendations( + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=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 optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'origin': "ALL", + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + 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", + ) + ], + ) + try: + api_response = api_instance.search_entities_knowledge_recommendations( + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=body, + ) + 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 +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**EntitySearchBody**](../../models/EntitySearchBody.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +origin | OriginSchema | | optional + + +# OriginSchema + +Defines scope of origin of objects. All by default. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Defines scope of origin of objects. All by default. | must be one of ["ALL", "PARENTS", "NATIVE", ] if omitted the server will use the default value of "ALL" + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#search_entities_knowledge_recommendations.ApiResponseFor200) | Request successfully processed + +#### search_entities_knowledge_recommendations.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationOutList**](../../models/JsonApiKnowledgeRecommendationOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationOutList**](../../models/JsonApiKnowledgeRecommendationOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_identity_search_body) + +Search request for MemoryItem + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags 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(configuration) as api_client: + # Create an instance of the API class + api_instance = ai_api.AIApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + header_params = { + } + 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", + ) + ], + ) + try: + # Search request for MemoryItem + api_response = api_instance.search_entities_memory_items( + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=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 optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'origin': "ALL", + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + 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", + ) + ], + ) + try: + # Search request for MemoryItem + api_response = api_instance.search_entities_memory_items( + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=body, + ) + 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 +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**EntitySearchBody**](../../models/EntitySearchBody.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +origin | OriginSchema | | optional + + +# OriginSchema + +Defines scope of origin of objects. All by default. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Defines scope of origin of objects. All by default. | must be one of ["ALL", "PARENTS", "NATIVE", ] if omitted the server will use the default value of "ALL" + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#search_entities_memory_items.ApiResponseFor200) | Request successfully processed + +#### search_entities_memory_items.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemOutList**](../../models/JsonApiMemoryItemOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemOutList**](../../models/JsonApiMemoryItemOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_idjson_api_knowledge_recommendation_in_document) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags 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(configuration) as api_client: + # Create an instance of the API class + api_instance = ai_api.AIApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + body = JsonApiKnowledgeRecommendationInDocument( + data=JsonApiKnowledgeRecommendationIn( + attributes=dict( + 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=dict(), + 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=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + metric=dict( + data=JsonApiMetricToOneLinkage(None), + ), + ), + type="knowledgeRecommendation", + ), + ) + try: + api_response = api_instance.update_entity_knowledge_recommendations( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->update_entity_knowledge_recommendations: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + 'include': [ + "metric,analyticalDashboard" + ], + } + body = JsonApiKnowledgeRecommendationInDocument( + data=JsonApiKnowledgeRecommendationIn( + attributes=dict( + 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=dict(), + 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=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + metric=dict( + data=JsonApiMetricToOneLinkage(None), + ), + ), + type="knowledgeRecommendation", + ), + ) + try: + api_response = api_instance.update_entity_knowledge_recommendations( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->update_entity_knowledge_recommendations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationInDocument**](../../models/JsonApiKnowledgeRecommendationInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationInDocument**](../../models/JsonApiKnowledgeRecommendationInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["metrics", "analyticalDashboards", "metric", "analyticalDashboard", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#update_entity_knowledge_recommendations.ApiResponseFor200) | Request successfully processed + +#### update_entity_knowledge_recommendations.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationOutDocument**](../../models/JsonApiKnowledgeRecommendationOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationOutDocument**](../../models/JsonApiKnowledgeRecommendationOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_idjson_api_memory_item_in_document) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags 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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + body = JsonApiMemoryItemInDocument( + data=JsonApiMemoryItemIn( + attributes=dict( + 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", + ), + ) + try: + api_response = api_instance.update_entity_memory_items( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->update_entity_memory_items: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + 'include': [ + "createdBy,modifiedBy" + ], + } + body = JsonApiMemoryItemInDocument( + data=JsonApiMemoryItemIn( + attributes=dict( + 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", + ), + ) + try: + api_response = api_instance.update_entity_memory_items( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->update_entity_memory_items: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemInDocument**](../../models/JsonApiMemoryItemInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemInDocument**](../../models/JsonApiMemoryItemInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["userIdentifiers", "createdBy", "modifiedBy", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#update_entity_memory_items.ApiResponseFor200) | Request successfully processed + +#### update_entity_memory_items.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemOutDocument**](../../models/JsonApiMemoryItemOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiMemoryItemOutDocument**](../../models/JsonApiMemoryItemOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/AILakeApi.md b/gooddata-api-client/docs/apis/tags/AILakeApi.md new file mode 100644 index 000000000..406406971 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/AILakeApi.md @@ -0,0 +1,832 @@ + +# gooddata_api_client.apis.tags.ai_lake_api.AILakeApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**deprovision_ai_lake_database_instance**](#deprovision_ai_lake_database_instance) | **delete** /api/v1/ailake/database/instances/{instanceId} | (BETA) Delete an existing AILake Database instance +[**get_ai_lake_database_instance**](#get_ai_lake_database_instance) | **get** /api/v1/ailake/database/instances/{instanceId} | (BETA) Get the specified AILake Database instance +[**get_ai_lake_operation**](#get_ai_lake_operation) | **get** /api/v1/ailake/operations/{operationId} | (BETA) Get Long Running Operation details +[**list_ai_lake_database_instances**](#list_ai_lake_database_instances) | **get** /api/v1/ailake/database/instances | (BETA) List AI Lake Database instances +[**list_ai_lake_services**](#list_ai_lake_services) | **get** /api/v1/ailake/services | (BETA) List AI Lake services +[**provision_ai_lake_database_instance**](#provision_ai_lake_database_instance) | **post** /api/v1/ailake/database/instances | (BETA) Create a new AILake Database instance +[**run_ai_lake_service_command**](#run_ai_lake_service_command) | **post** /api/v1/ailake/services/{serviceId}/commands/{commandName}/run | (BETA) Run an AI Lake services command + +# **deprovision_ai_lake_database_instance** + +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} 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. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags 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(configuration) as api_client: + # Create an instance of the API class + api_instance = ai_lake_api.AILakeApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'instanceId': "instanceId_example", + } + header_params = { + } + try: + # (BETA) Delete an existing AILake Database instance + api_response = api_instance.deprovision_ai_lake_database_instance( + path_params=path_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->deprovision_ai_lake_database_instance: %s\n" % e) + + # example passing only optional values + path_params = { + 'instanceId': "instanceId_example", + } + header_params = { + 'operation-id': "operation-id_example", + } + try: + # (BETA) Delete an existing AILake Database instance + api_response = api_instance.deprovision_ai_lake_database_instance( + path_params=path_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->deprovision_ai_lake_database_instance: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +operation-id | OperationIdSchema | | optional + +# OperationIdSchema + +Operation ID to use for polling. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Operation ID to use for polling. | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +instanceId | InstanceIdSchema | | + +# InstanceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +202 | [ApiResponseFor202](#deprovision_ai_lake_database_instance.ApiResponseFor202) | Accepted + +#### deprovision_ai_lake_database_instance.ApiResponseFor202 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor202ResponseBodyApplicationJson, ] | | +headers | ResponseHeadersFor202 | | + +# SchemaFor202ResponseBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | +#### ResponseHeadersFor202 + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +operation-id | OperationIdSchema | | +operation-location | OperationLocationSchema | | + +# OperationIdSchema + +Operation ID to use for polling. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Operation ID to use for polling. | + +# OperationLocationSchema + +Operation location URL that can be used for polling. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Operation location URL that can be used for polling. | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_database_instance** + +> DatabaseInstance get_ai_lake_database_instance(instance_id) + +(BETA) Get the specified AILake Database instance + +(BETA) Retrieve details of the specified AI Lake database instance in the organization's AI Lake. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import ai_lake_api +from gooddata_api_client.model.database_instance import DatabaseInstance +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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_lake_api.AILakeApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'instanceId': "instanceId_example", + } + try: + # (BETA) Get the specified AILake Database instance + api_response = api_instance.get_ai_lake_database_instance( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->get_ai_lake_database_instance: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +instanceId | InstanceIdSchema | | + +# InstanceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_ai_lake_database_instance.ApiResponseFor200) | AI Lake database instance successfully retrieved + +#### get_ai_lake_database_instance.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**DatabaseInstance**](../../models/DatabaseInstance.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_operation** + +> bool, date, datetime, dict, float, int, list, str, none_type get_ai_lake_operation(operation_id) + +(BETA) Get Long Running Operation details + +(BETA) Retrieves details of a Long Running Operation specified by the operation-id. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import ai_lake_api +from gooddata_api_client.model.failed_operation import FailedOperation +from gooddata_api_client.model.pending_operation import PendingOperation +from gooddata_api_client.model.succeeded_operation import SucceededOperation +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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_lake_api.AILakeApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'operationId': "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + } + try: + # (BETA) Get Long Running Operation details + api_response = api_instance.get_ai_lake_operation( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->get_ai_lake_operation: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +operationId | OperationIdSchema | | + +# OperationIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_ai_lake_operation.ApiResponseFor200) | AI Lake Long Running Operation details successfully retrieved + +#### get_ai_lake_operation.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[FailedOperation]({{complexTypePrefix}}FailedOperation.md) | [**FailedOperation**]({{complexTypePrefix}}FailedOperation.md) | [**FailedOperation**]({{complexTypePrefix}}FailedOperation.md) | | +[PendingOperation]({{complexTypePrefix}}PendingOperation.md) | [**PendingOperation**]({{complexTypePrefix}}PendingOperation.md) | [**PendingOperation**]({{complexTypePrefix}}PendingOperation.md) | | +[SucceededOperation]({{complexTypePrefix}}SucceededOperation.md) | [**SucceededOperation**]({{complexTypePrefix}}SucceededOperation.md) | [**SucceededOperation**]({{complexTypePrefix}}SucceededOperation.md) | | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_database_instances** + +> [DatabaseInstance] list_ai_lake_database_instances() + +(BETA) List AI Lake Database instances + +(BETA) Lists database instances in the organization's AI Lake. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import ai_lake_api +from gooddata_api_client.model.database_instance import DatabaseInstance +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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_lake_api.AILakeApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # (BETA) List AI Lake Database instances + api_response = api_instance.list_ai_lake_database_instances() + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->list_ai_lake_database_instances: %s\n" % e) +``` +### Parameters +This endpoint does not need any parameter. + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#list_ai_lake_database_instances.ApiResponseFor200) | AI Lake database instances successfully retrieved + +#### list_ai_lake_database_instances.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DatabaseInstance**]({{complexTypePrefix}}DatabaseInstance.md) | [**DatabaseInstance**]({{complexTypePrefix}}DatabaseInstance.md) | [**DatabaseInstance**]({{complexTypePrefix}}DatabaseInstance.md) | | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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** + +> [ServiceInfo] list_ai_lake_services() + +(BETA) List AI Lake services + +(BETA) Lists services configured for the organization's AI Lake. Returns only non-sensitive fields (id, name). + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import ai_lake_api +from gooddata_api_client.model.service_info import ServiceInfo +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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_lake_api.AILakeApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # (BETA) List AI Lake services + api_response = api_instance.list_ai_lake_services() + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->list_ai_lake_services: %s\n" % e) +``` +### Parameters +This endpoint does not need any parameter. + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#list_ai_lake_services.ApiResponseFor200) | AI Lake services successfully retrieved + +#### list_ai_lake_services.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ServiceInfo**]({{complexTypePrefix}}ServiceInfo.md) | [**ServiceInfo**]({{complexTypePrefix}}ServiceInfo.md) | [**ServiceInfo**]({{complexTypePrefix}}ServiceInfo.md) | | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **provision_ai_lake_database_instance** + +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} provision_ai_lake_database_instance(provision_database_instance_request) + +(BETA) Create a new AILake Database instance + +(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. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import ai_lake_api +from gooddata_api_client.model.provision_database_instance_request import ProvisionDatabaseInstanceRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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_lake_api.AILakeApi(api_client) + + # example passing only required values which don't have defaults set + header_params = { + } + body = ProvisionDatabaseInstanceRequest( + name="name_example", + storage_ids=[ + "storage_ids_example" + ], + ) + try: + # (BETA) Create a new AILake Database instance + api_response = api_instance.provision_ai_lake_database_instance( + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->provision_ai_lake_database_instance: %s\n" % e) + + # example passing only optional values + header_params = { + 'operation-id': "operation-id_example", + } + body = ProvisionDatabaseInstanceRequest( + name="name_example", + storage_ids=[ + "storage_ids_example" + ], + ) + try: + # (BETA) Create a new AILake Database instance + api_response = api_instance.provision_ai_lake_database_instance( + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->provision_ai_lake_database_instance: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +header_params | RequestHeaderParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ProvisionDatabaseInstanceRequest**](../../models/ProvisionDatabaseInstanceRequest.md) | | + + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +operation-id | OperationIdSchema | | optional + +# OperationIdSchema + +Operation ID to use for polling. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Operation ID to use for polling. | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +202 | [ApiResponseFor202](#provision_ai_lake_database_instance.ApiResponseFor202) | Accepted + +#### provision_ai_lake_database_instance.ApiResponseFor202 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor202ResponseBodyApplicationJson, ] | | +headers | ResponseHeadersFor202 | | + +# SchemaFor202ResponseBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | +#### ResponseHeadersFor202 + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +operation-id | OperationIdSchema | | +operation-location | OperationLocationSchema | | + +# OperationIdSchema + +Operation ID to use for polling. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Operation ID to use for polling. | + +# OperationLocationSchema + +Operation location URL that can be used for polling. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Operation location URL that can be used for polling. | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **run_ai_lake_service_command** + +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} run_ai_lake_service_command(service_idcommand_namerun_service_command_request) + +(BETA) Run an AI Lake services command + +(BETA) Runs a specific AI Lake service command. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import ai_lake_api +from gooddata_api_client.model.run_service_command_request import RunServiceCommandRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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_lake_api.AILakeApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'serviceId': "serviceId_example", + 'commandName': "commandName_example", + } + header_params = { + } + body = RunServiceCommandRequest( + context=dict( + "key": "key_example", + ), + payload=JsonNode(), + ) + try: + # (BETA) Run an AI Lake services command + api_response = api_instance.run_ai_lake_service_command( + path_params=path_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->run_ai_lake_service_command: %s\n" % e) + + # example passing only optional values + path_params = { + 'serviceId': "serviceId_example", + 'commandName': "commandName_example", + } + header_params = { + 'operation-id': "operation-id_example", + } + body = RunServiceCommandRequest( + context=dict( + "key": "key_example", + ), + payload=JsonNode(), + ) + try: + # (BETA) Run an AI Lake services command + api_response = api_instance.run_ai_lake_service_command( + path_params=path_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->run_ai_lake_service_command: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**RunServiceCommandRequest**](../../models/RunServiceCommandRequest.md) | | + + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +operation-id | OperationIdSchema | | optional + +# OperationIdSchema + +Operation ID to use for polling. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Operation ID to use for polling. | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +serviceId | ServiceIdSchema | | +commandName | CommandNameSchema | | + +# ServiceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# CommandNameSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +202 | [ApiResponseFor202](#run_ai_lake_service_command.ApiResponseFor202) | Accepted + +#### run_ai_lake_service_command.ApiResponseFor202 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor202ResponseBodyApplicationJson, ] | | +headers | ResponseHeadersFor202 | | + +# SchemaFor202ResponseBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | +#### ResponseHeadersFor202 + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +operation-id | OperationIdSchema | | +operation-location | OperationLocationSchema | | + +# OperationIdSchema + +Operation ID to use for polling. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Operation ID to use for polling. | + +# OperationLocationSchema + +Operation location URL that can be used for polling. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Operation location URL that can be used for polling. | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/AacApi.md b/gooddata-api-client/docs/apis/tags/AacApi.md new file mode 100644 index 000000000..b4549602f --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/AacApi.md @@ -0,0 +1,671 @@ + +# gooddata_api_client.apis.tags.aac_api.AacApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_analytics_model_aac**](#get_analytics_model_aac) | **get** /api/v1/aac/workspaces/{workspaceId}/analyticsModel | Get analytics model in AAC format +[**get_logical_model_aac**](#get_logical_model_aac) | **get** /api/v1/aac/workspaces/{workspaceId}/logicalModel | Get logical model in AAC format +[**set_analytics_model_aac**](#set_analytics_model_aac) | **put** /api/v1/aac/workspaces/{workspaceId}/analyticsModel | Set analytics model from AAC format +[**set_logical_model_aac**](#set_logical_model_aac) | **put** /api/v1/aac/workspaces/{workspaceId}/logicalModel | Set logical model from AAC format + +# **get_analytics_model_aac** + +> AacAnalyticsModel get_analytics_model_aac(workspace_id) + +Get analytics model in AAC format + + Retrieve the analytics model of the workspace in Analytics as Code format. The returned format is compatible with the YAML definitions used by the GoodData Analytics as Code VSCode extension. This includes metrics, dashboards, visualizations, plugins, and attribute hierarchies. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import aac_api +from gooddata_api_client.model.aac_analytics_model import AacAnalyticsModel +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = aac_api.AacApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + try: + # Get analytics model in AAC format + api_response = api_instance.get_analytics_model_aac( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AacApi->get_analytics_model_aac: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'exclude': [ + "ACTIVITY_INFO" + ], + } + try: + # Get analytics model in AAC format + api_response = api_instance.get_analytics_model_aac( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AacApi->get_analytics_model_aac: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +exclude | ExcludeSchema | | optional + + +# ExcludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Defines properties which should not be included in the payload. | must be one of ["ACTIVITY_INFO", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_analytics_model_aac.ApiResponseFor200) | Retrieved current analytics model in AAC format. + +#### get_analytics_model_aac.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**AacAnalyticsModel**](../../models/AacAnalyticsModel.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_logical_model_aac** + +> AacLogicalModel get_logical_model_aac(workspace_id) + +Get logical model in AAC format + + Retrieve the logical data model of the workspace in Analytics as Code format. The returned format is compatible with the YAML definitions used by the GoodData Analytics as Code VSCode extension. Use this for exporting models that can be directly used as YAML configuration files. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import aac_api +from gooddata_api_client.model.aac_logical_model import AacLogicalModel +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = aac_api.AacApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + try: + # Get logical model in AAC format + api_response = api_instance.get_logical_model_aac( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AacApi->get_logical_model_aac: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'includeParents': True, + } + try: + # Get logical model in AAC format + api_response = api_instance.get_logical_model_aac( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AacApi->get_logical_model_aac: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +includeParents | IncludeParentsSchema | | optional + + +# IncludeParentsSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_logical_model_aac.ApiResponseFor200) | Retrieved current logical model in AAC format. + +#### get_logical_model_aac.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**AacLogicalModel**](../../models/AacLogicalModel.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **set_analytics_model_aac** + +> set_analytics_model_aac(workspace_idaac_analytics_model) + +Set analytics model from AAC format + + Set the analytics model of the workspace using Analytics as Code format. The input format is compatible with the YAML definitions used by the GoodData Analytics as Code VSCode extension. This replaces the entire analytics model with the provided definition, including metrics, dashboards, visualizations, plugins, and attribute hierarchies. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import aac_api +from gooddata_api_client.model.aac_analytics_model import AacAnalyticsModel +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = aac_api.AacApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = AacAnalyticsModel( + attribute_hierarchies=[ + AacAttributeHierarchy( + attributes=["attribute/country","attribute/state","attribute/city"], + description="description_example", + id="geo-hierarchy", + tags=[ + "tags_example" + ], + title="Geographic Hierarchy", + type="attribute_hierarchy", + ) + ], + dashboards=[ + AacDashboard(None) + ], + metrics=[ + AacMetric( + description="description_example", + format="#,##0.00", + id="total-sales", + is_hidden=True, + is_hidden_from_kda=True, + maql="SELECT SUM({fact/amount})", + show_in_ai_results=True, +, + title="Total Sales", + type="metric", + ) + ], + plugins=[ + AacPlugin( + description="description_example", + id="my-plugin", +, + title="My Plugin", + type="plugin", + url="https://example.com/plugin.js", + ) + ], + visualizations=[ + AacVisualization( + additional_properties=dict( + "key": JsonNode(), + ), + attributes=[ + None + ], + columns=[], + config=JsonNode(), + description="description_example", + _from=JsonNode(), + id="sales-by-region", + is_hidden=True, + layers=[ + AacVisualizationLayer( + additional_properties=dict(), + config=JsonNode(), + filters=dict( + "key": AacQueryFilter( + additional_properties=dict(), + attribute="attribute_example", + bottom=1, + condition="condition_example", + dimensionality=[ + "dimensionality_example" + ], + display_as="display_as_example", + _from=None, + granularity="granularity_example", + null_values_as_zero=True, + state=AacFilterState( + exclude=[ + "exclude_example" + ], + include=[ + "include_example" + ], + ), +, + top=1, + type="date_filter", + using="using_example", + value=3.14, + ), + ), + id="id_example", + metrics=[], + segment_by=[], + sorts=[ + JsonNode() + ], + title="title_example", + type="pushpin", + view_by=[], + ) + ], + metrics=[], + query=AacQuery( + fields=dict( +, + ), + filter_by=dict( + "key": AacQueryFilter(), + ), + sort_by=[ + JsonNode() + ], + ), + rows=[], + segment_by=[], + show_in_ai_results=True, + size_by=[], + stack_by=[], +, + title="Sales by Region", + to=JsonNode(), + trend_by=[], + type="AacVisualizationBasicBuckets", + view_by=[], + ) + ], + ) + try: + # Set analytics model from AAC format + api_response = api_instance.set_analytics_model_aac( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AacApi->set_analytics_model_aac: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**AacAnalyticsModel**](../../models/AacAnalyticsModel.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#set_analytics_model_aac.ApiResponseFor204) | Analytics model successfully set. + +#### set_analytics_model_aac.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **set_logical_model_aac** + +> set_logical_model_aac(workspace_idaac_logical_model) + +Set logical model from AAC format + + Set the logical data model of the workspace using Analytics as Code format. The input format is compatible with the YAML definitions used by the GoodData Analytics as Code VSCode extension. This replaces the entire logical model with the provided definition. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import aac_api +from gooddata_api_client.model.aac_logical_model import AacLogicalModel +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = aac_api.AacApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = AacLogicalModel( + datasets=[ + AacDataset( + data_source="my-postgres", + description="description_example", + fields=dict( + "key": AacField( + aggregated_as="SUM", + assigned_to="assigned_to_example", + data_type="STRING", + default_view="default_view_example", + description="description_example", + is_hidden=True, + labels=dict( + "key": AacLabel( + data_type="INT", + description="description_example", + geo_area_config=AacGeoAreaConfig( + collection=AacGeoCollectionIdentifier( + id="id_example", + kind="STATIC", + ), + ), + is_hidden=True, + locale="locale_example", + show_in_ai_results=True, + source_column="source_column_example", + tags=[ + "tags_example" + ], + title="title_example", + translations=[ + AacLabelTranslation( + locale="locale_example", + source_column="source_column_example", + ) + ], + value_type="TEXT", + ), + ), + locale="locale_example", + show_in_ai_results=True, + sort_column="sort_column_example", + sort_direction="ASC", + source_column="source_column_example", +, + title="title_example", + type="attribute", + ), + ), + id="customers", + precedence=1, + primary_key=None, + references=[ + AacReference( + dataset="orders", + multi_directional=True, + sources=[ + AacReferenceSource( + data_type="INT", + source_column="source_column_example", + target="target_example", + ) + ], + ) + ], + sql="sql_example", + table_path="public/customers", +, + title="Customers", + type="dataset", + workspace_data_filters=[ + AacWorkspaceDataFilter( + data_type="INT", + filter_id="filter_id_example", + source_column="source_column_example", + ) + ], + ) + ], + date_datasets=[ + AacDateDataset( + description="description_example", + granularities=[ + "granularities_example" + ], + id="date", +, + title="Date", + title_base="title_base_example", + title_pattern="title_pattern_example", + type="date", + ) + ], + ) + try: + # Set logical model from AAC format + api_response = api_instance.set_logical_model_aac( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AacApi->set_logical_model_aac: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**AacLogicalModel**](../../models/AacLogicalModel.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#set_logical_model_aac.ApiResponseFor204) | Logical model successfully set. + +#### set_logical_model_aac.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/AttributeHierarchiesApi.md b/gooddata-api-client/docs/apis/tags/AttributeHierarchiesApi.md new file mode 100644 index 000000000..dfcec49c4 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/AttributeHierarchiesApi.md @@ -0,0 +1,1378 @@ + +# gooddata_api_client.apis.tags.attribute_hierarchies_api.AttributeHierarchiesApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_attribute_hierarchies**](#create_entity_attribute_hierarchies) | **post** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Post Attribute Hierarchies +[**delete_entity_attribute_hierarchies**](#delete_entity_attribute_hierarchies) | **delete** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Delete an Attribute Hierarchy +[**get_all_entities_attribute_hierarchies**](#get_all_entities_attribute_hierarchies) | **get** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Get all Attribute Hierarchies +[**get_entity_attribute_hierarchies**](#get_entity_attribute_hierarchies) | **get** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Get an Attribute Hierarchy +[**patch_entity_attribute_hierarchies**](#patch_entity_attribute_hierarchies) | **patch** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Patch an Attribute Hierarchy +[**search_entities_attribute_hierarchies**](#search_entities_attribute_hierarchies) | **post** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | Search request for AttributeHierarchy +[**update_entity_attribute_hierarchies**](#update_entity_attribute_hierarchies) | **put** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Put an Attribute Hierarchy + +# **create_entity_attribute_hierarchies** + +> JsonApiAttributeHierarchyOutDocument create_entity_attribute_hierarchies(workspace_idjson_api_attribute_hierarchy_in_document) + +Post Attribute Hierarchies + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import attribute_hierarchies_api +from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +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(configuration) as api_client: + # Create an instance of the API class + api_instance = attribute_hierarchies_api.AttributeHierarchiesApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + body = JsonApiAttributeHierarchyInDocument( + data=JsonApiAttributeHierarchyIn( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + type="attributeHierarchy", + ), + ) + try: + # Post Attribute Hierarchies + api_response = api_instance.create_entity_attribute_hierarchies( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchiesApi->create_entity_attribute_hierarchies: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'include': [ + "createdBy,modifiedBy,attributes" + ], + 'metaInclude': [ + "metaInclude=origin,all" + ], + } + body = JsonApiAttributeHierarchyInDocument( + data=JsonApiAttributeHierarchyIn( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + type="attributeHierarchy", + ), + ) + try: + # Post Attribute Hierarchies + api_response = api_instance.create_entity_attribute_hierarchies( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchiesApi->create_entity_attribute_hierarchies: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyInDocument**](../../models/JsonApiAttributeHierarchyInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyInDocument**](../../models/JsonApiAttributeHierarchyInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +include | IncludeSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["userIdentifiers", "attributes", "createdBy", "modifiedBy", "ALL", ] + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "all", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_entity_attribute_hierarchies.ApiResponseFor201) | Request successfully processed + +#### create_entity_attribute_hierarchies.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, SchemaFor201ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyOutDocument**](../../models/JsonApiAttributeHierarchyOutDocument.md) | | + + +# SchemaFor201ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyOutDocument**](../../models/JsonApiAttributeHierarchyOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_id) + +Delete an Attribute Hierarchy + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import attribute_hierarchies_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(configuration) as api_client: + # Create an instance of the API class + api_instance = attribute_hierarchies_api.AttributeHierarchiesApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + try: + # Delete an Attribute Hierarchy + api_response = api_instance.delete_entity_attribute_hierarchies( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchiesApi->delete_entity_attribute_hierarchies: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + } + try: + # Delete an Attribute Hierarchy + api_response = api_instance.delete_entity_attribute_hierarchies( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchiesApi->delete_entity_attribute_hierarchies: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_entity_attribute_hierarchies.ApiResponseFor204) | Successfully deleted + +#### delete_entity_attribute_hierarchies.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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) + +Get all Attribute Hierarchies + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import attribute_hierarchies_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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = attribute_hierarchies_api.AttributeHierarchiesApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + header_params = { + } + try: + # Get all Attribute Hierarchies + api_response = api_instance.get_all_entities_attribute_hierarchies( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchiesApi->get_all_entities_attribute_hierarchies: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'origin': "ALL", + 'filter': "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + 'include': [ + "createdBy,modifiedBy,attributes" + ], + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=origin,page,all" + ], + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + try: + # Get all Attribute Hierarchies + api_response = api_instance.get_all_entities_attribute_hierarchies( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchiesApi->get_all_entities_attribute_hierarchies: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +origin | OriginSchema | | optional +filter | FilterSchema | | optional +include | IncludeSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# OriginSchema + +Defines scope of origin of objects. All by default. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Defines scope of origin of objects. All by default. | must be one of ["ALL", "PARENTS", "NATIVE", ] if omitted the server will use the default value of "ALL" + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["userIdentifiers", "attributes", "createdBy", "modifiedBy", "ALL", ] + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "page", "all", "ALL", ] + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_entities_attribute_hierarchies.ApiResponseFor200) | Request successfully processed + +#### get_all_entities_attribute_hierarchies.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyOutList**](../../models/JsonApiAttributeHierarchyOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyOutList**](../../models/JsonApiAttributeHierarchyOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_id) + +Get an Attribute Hierarchy + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import attribute_hierarchies_api +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(configuration) as api_client: + # Create an instance of the API class + api_instance = attribute_hierarchies_api.AttributeHierarchiesApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + header_params = { + } + try: + # Get an Attribute Hierarchy + api_response = api_instance.get_entity_attribute_hierarchies( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchiesApi->get_entity_attribute_hierarchies: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + 'include': [ + "createdBy,modifiedBy,attributes" + ], + 'metaInclude': [ + "metaInclude=origin,all" + ], + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + try: + # Get an Attribute Hierarchy + api_response = api_instance.get_entity_attribute_hierarchies( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchiesApi->get_entity_attribute_hierarchies: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["userIdentifiers", "attributes", "createdBy", "modifiedBy", "ALL", ] + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "all", "ALL", ] + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_entity_attribute_hierarchies.ApiResponseFor200) | Request successfully processed + +#### get_entity_attribute_hierarchies.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyOutDocument**](../../models/JsonApiAttributeHierarchyOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyOutDocument**](../../models/JsonApiAttributeHierarchyOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_idjson_api_attribute_hierarchy_patch_document) + +Patch an Attribute Hierarchy + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import attribute_hierarchies_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(configuration) as api_client: + # Create an instance of the API class + api_instance = attribute_hierarchies_api.AttributeHierarchiesApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + body = JsonApiAttributeHierarchyPatchDocument( + data=JsonApiAttributeHierarchyPatch( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + type="attributeHierarchy", + ), + ) + try: + # Patch an Attribute Hierarchy + api_response = api_instance.patch_entity_attribute_hierarchies( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchiesApi->patch_entity_attribute_hierarchies: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + 'include': [ + "createdBy,modifiedBy,attributes" + ], + } + body = JsonApiAttributeHierarchyPatchDocument( + data=JsonApiAttributeHierarchyPatch( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + type="attributeHierarchy", + ), + ) + try: + # Patch an Attribute Hierarchy + api_response = api_instance.patch_entity_attribute_hierarchies( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchiesApi->patch_entity_attribute_hierarchies: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyPatchDocument**](../../models/JsonApiAttributeHierarchyPatchDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyPatchDocument**](../../models/JsonApiAttributeHierarchyPatchDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["userIdentifiers", "attributes", "createdBy", "modifiedBy", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#patch_entity_attribute_hierarchies.ApiResponseFor200) | Request successfully processed + +#### patch_entity_attribute_hierarchies.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyOutDocument**](../../models/JsonApiAttributeHierarchyOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyOutDocument**](../../models/JsonApiAttributeHierarchyOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_attribute_hierarchies** + +> JsonApiAttributeHierarchyOutList search_entities_attribute_hierarchies(workspace_identity_search_body) + +Search request for AttributeHierarchy + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import attribute_hierarchies_api +from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +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(configuration) as api_client: + # Create an instance of the API class + api_instance = attribute_hierarchies_api.AttributeHierarchiesApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + header_params = { + } + 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", + ) + ], + ) + try: + # Search request for AttributeHierarchy + api_response = api_instance.search_entities_attribute_hierarchies( + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchiesApi->search_entities_attribute_hierarchies: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'origin': "ALL", + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + 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", + ) + ], + ) + try: + # Search request for AttributeHierarchy + api_response = api_instance.search_entities_attribute_hierarchies( + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchiesApi->search_entities_attribute_hierarchies: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**EntitySearchBody**](../../models/EntitySearchBody.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +origin | OriginSchema | | optional + + +# OriginSchema + +Defines scope of origin of objects. All by default. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Defines scope of origin of objects. All by default. | must be one of ["ALL", "PARENTS", "NATIVE", ] if omitted the server will use the default value of "ALL" + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#search_entities_attribute_hierarchies.ApiResponseFor200) | Request successfully processed + +#### search_entities_attribute_hierarchies.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyOutList**](../../models/JsonApiAttributeHierarchyOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyOutList**](../../models/JsonApiAttributeHierarchyOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_attribute_hierarchies** + +> JsonApiAttributeHierarchyOutDocument update_entity_attribute_hierarchies(workspace_idobject_idjson_api_attribute_hierarchy_in_document) + +Put an Attribute Hierarchy + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import attribute_hierarchies_api +from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +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(configuration) as api_client: + # Create an instance of the API class + api_instance = attribute_hierarchies_api.AttributeHierarchiesApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + body = JsonApiAttributeHierarchyInDocument( + data=JsonApiAttributeHierarchyIn( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + type="attributeHierarchy", + ), + ) + try: + # Put an Attribute Hierarchy + api_response = api_instance.update_entity_attribute_hierarchies( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchiesApi->update_entity_attribute_hierarchies: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + 'include': [ + "createdBy,modifiedBy,attributes" + ], + } + body = JsonApiAttributeHierarchyInDocument( + data=JsonApiAttributeHierarchyIn( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + type="attributeHierarchy", + ), + ) + try: + # Put an Attribute Hierarchy + api_response = api_instance.update_entity_attribute_hierarchies( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AttributeHierarchiesApi->update_entity_attribute_hierarchies: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyInDocument**](../../models/JsonApiAttributeHierarchyInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyInDocument**](../../models/JsonApiAttributeHierarchyInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["userIdentifiers", "attributes", "createdBy", "modifiedBy", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#update_entity_attribute_hierarchies.ApiResponseFor200) | Request successfully processed + +#### update_entity_attribute_hierarchies.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyOutDocument**](../../models/JsonApiAttributeHierarchyOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyOutDocument**](../../models/JsonApiAttributeHierarchyOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/AutomationOrganizationViewControllerApi.md b/gooddata-api-client/docs/apis/tags/AutomationOrganizationViewControllerApi.md new file mode 100644 index 000000000..3e778013e --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/AutomationOrganizationViewControllerApi.md @@ -0,0 +1,171 @@ + +# gooddata_api_client.apis.tags.automation_organization_view_controller_api.AutomationOrganizationViewControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_all_automations_workspace_automations**](#get_all_automations_workspace_automations) | **get** /api/v1/entities/organization/workspaceAutomations | Get all Automations across all Workspaces + +# **get_all_automations_workspace_automations** + +> JsonApiWorkspaceAutomationOutList get_all_automations_workspace_automations() + +Get all Automations across all Workspaces + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automation_organization_view_controller_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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automation_organization_view_controller_api.AutomationOrganizationViewControllerApi(api_client) + + # example passing only optional values + query_params = { + 'filter': "title==someString;description==someString;workspace.id==321;notificationChannel.id==321", + 'include': [ + "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults" + ], + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=page,all" + ], + } + try: + # Get all Automations across all Workspaces + api_response = api_instance.get_all_automations_workspace_automations( + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationOrganizationViewControllerApi->get_all_automations_workspace_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["workspaces", "notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "workspace", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL", ] + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["page", "all", "ALL", ] + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_automations_workspace_automations.ApiResponseFor200) | Request successfully processed + +#### get_all_automations_workspace_automations.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiWorkspaceAutomationOutList**](../../models/JsonApiWorkspaceAutomationOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiWorkspaceAutomationOutList**](../../models/JsonApiWorkspaceAutomationOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/AutomationsApi.md b/gooddata-api-client/docs/apis/tags/AutomationsApi.md new file mode 100644 index 000000000..dd0fbd9cb --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/AutomationsApi.md @@ -0,0 +1,4977 @@ + +# gooddata_api_client.apis.tags.automations_api.AutomationsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_automations**](#create_entity_automations) | **post** /api/v1/entities/workspaces/{workspaceId}/automations | Post Automations +[**delete_entity_automations**](#delete_entity_automations) | **delete** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Delete an Automation +[**delete_organization_automations**](#delete_organization_automations) | **post** /api/v1/actions/organization/automations/delete | Delete selected automations across all workspaces +[**delete_workspace_automations**](#delete_workspace_automations) | **post** /api/v1/actions/workspaces/{workspaceId}/automations/delete | Delete selected automations in the workspace +[**get_all_automations_workspace_automations**](#get_all_automations_workspace_automations) | **get** /api/v1/entities/organization/workspaceAutomations | Get all Automations across all Workspaces +[**get_all_entities_automations**](#get_all_entities_automations) | **get** /api/v1/entities/workspaces/{workspaceId}/automations | Get all Automations +[**get_automations**](#get_automations) | **get** /api/v1/layout/workspaces/{workspaceId}/automations | Get automations +[**get_entity_automations**](#get_entity_automations) | **get** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Get an Automation +[**patch_entity_automations**](#patch_entity_automations) | **patch** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation +[**pause_organization_automations**](#pause_organization_automations) | **post** /api/v1/actions/organization/automations/pause | Pause selected automations across all workspaces +[**pause_workspace_automations**](#pause_workspace_automations) | **post** /api/v1/actions/workspaces/{workspaceId}/automations/pause | Pause selected automations in the workspace +[**search_entities_automation_results**](#search_entities_automation_results) | **post** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | Search request for AutomationResult +[**search_entities_automations**](#search_entities_automations) | **post** /api/v1/entities/workspaces/{workspaceId}/automations/search | Search request for Automation +[**set_automations**](#set_automations) | **put** /api/v1/layout/workspaces/{workspaceId}/automations | Set automations +[**trigger_automation**](#trigger_automation) | **post** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation. +[**trigger_existing_automation**](#trigger_existing_automation) | **post** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation. +[**unpause_organization_automations**](#unpause_organization_automations) | **post** /api/v1/actions/organization/automations/unpause | Unpause selected automations across all workspaces +[**unpause_workspace_automations**](#unpause_workspace_automations) | **post** /api/v1/actions/workspaces/{workspaceId}/automations/unpause | Unpause selected automations in the workspace +[**unsubscribe_all_automations**](#unsubscribe_all_automations) | **delete** /api/v1/actions/organization/automations/unsubscribe | Unsubscribe from all automations in all workspaces +[**unsubscribe_automation**](#unsubscribe_automation) | **delete** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe | Unsubscribe from an automation +[**unsubscribe_organization_automations**](#unsubscribe_organization_automations) | **post** /api/v1/actions/organization/automations/unsubscribe | Unsubscribe from selected automations across all workspaces +[**unsubscribe_selected_workspace_automations**](#unsubscribe_selected_workspace_automations) | **post** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from selected automations in the workspace +[**unsubscribe_workspace_automations**](#unsubscribe_workspace_automations) | **delete** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from all automations in the workspace +[**update_entity_automations**](#update_entity_automations) | **put** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Put an Automation + +# **create_entity_automations** + +> JsonApiAutomationOutDocument create_entity_automations(workspace_idjson_api_automation_in_document) + +Post Automations + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_api +from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + body = JsonApiAutomationInDocument( + data=JsonApiAutomationIn( + attributes=dict( + alert=dict( + condition=AlertCondition(), + execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=dict( + id="sample_item.price", + type="label", + ), + ), + local_identifier="attribute_1", + show_all_values=False, + ) + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ) + ], + filters=[ + FilterDefinition() + ], + measures=[ + MeasureItem() + ], + ), + interval="DAY", + trigger="ALWAYS", + ), + are_relations_valid=True, + dashboard_tabular_exports=[ + dict( + request_payload=DashboardTabularExportRequestV2( + dashboard_filters_override=[ + DashboardFilter() + ], + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + dashboard_tabs_filters_overrides=dict( + "key": [ + DashboardFilter() + ], + ), + file_name="result", + format="XLSX", + settings=DashboardExportSettings( + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + ), + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + description="description_example", + details=dict(), + evaluation_mode="SHARED", + external_recipients=[ + dict( + email="email_example", + ) + ], + image_exports=[ + dict( + request_payload=ImageExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PNG", + metadata=JsonNode(), + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + metadata=dict( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ) + ], + widget="widget_example", + ), + raw_exports=[ + dict( + request_payload=RawExportAutomationRequest( + custom_override=RawCustomOverride( + labels=dict( + "key": RawCustomLabel( + title="title_example", + ), + ), + metrics=dict( + "key": RawCustomMetric( + title="title_example", + ), + ), + ), + delimiter="U", + execution=AFM( + attributes=[ + AttributeItem() + ], +, + filters=[ + FilterDefinition() + ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=dict( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=dict( + id="sample_item.price", + type="attribute", + ), + ), + ) + ], + measures=[ + MeasureItem() + ], + ), + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp="1970-01-01T00:00:00.00Z", + ), + file_name="result", + format="CSV", + metadata=JsonNode(), + ), + ) + ], + schedule=dict( + cron="0 */30 9-17 ? * MON-FRI", + cron_description="cron_description_example", + first_run="2025-01-01T12:00Z", + timezone="Europe/Prague", + ), + slides_exports=[ + dict( + request_payload=SlidesExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + template_id="template_id_example", + visualization_ids=[ + "visualization_ids_example" + ], + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + state="ACTIVE", + tabular_exports=[ + dict( + request_payload=TabularExportRequest( + custom_override=CustomOverride( + labels=dict( + "key": CustomLabel(), + ), + metrics=dict( + "key": CustomMetric( + format="format_example", + title="title_example", + ), + ), + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + file_name="result", + format="CSV", + metadata=JsonNode(), + related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + settings=Settings( + delimiter="U", + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + pdf_page_size="a4 landscape", + pdf_table_style=[{"properties":[{"key":"font-size","value":"30px"}],"selector":"th"}], + pdf_top_left_content="Good", + pdf_top_right_content="Morning", + show_filters=False, + ), + visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", + visualization_object_custom_filters=[ + dict() + ], + ), + ) + ], + tags=[ + "tags_example" + ], + title="title_example", + visual_exports=[ + dict( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata=dict(), + ), + ) + ], + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + export_definitions=dict( + data=JsonApiExportDefinitionToManyLinkage([ + JsonApiExportDefinitionLinkage( + id="id_example", + type="exportDefinition", + ) + ]), + ), + notification_channel=dict( + data=JsonApiNotificationChannelToOneLinkage(None), + ), + recipients=dict( + data=JsonApiUserToManyLinkage([ + JsonApiUserLinkage( + id="id_example", + type="user", + ) + ]), + ), + ), + type="automation", + ), + ) + try: + # Post Automations + api_response = api_instance.create_entity_automations( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->create_entity_automations: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'include': [ + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults" + ], + 'metaInclude': [ + "metaInclude=origin,all" + ], + } + body = JsonApiAutomationInDocument( + data=JsonApiAutomationIn( + attributes=dict( + alert=dict( + condition=AlertCondition(), + execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=dict( + id="sample_item.price", + type="label", + ), + ), + local_identifier="attribute_1", + show_all_values=False, + ) + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ) + ], + filters=[ + FilterDefinition() + ], + measures=[ + MeasureItem() + ], + ), + interval="DAY", + trigger="ALWAYS", + ), + are_relations_valid=True, + dashboard_tabular_exports=[ + dict( + request_payload=DashboardTabularExportRequestV2( + dashboard_filters_override=[ + DashboardFilter() + ], + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + dashboard_tabs_filters_overrides=dict( + "key": [ + DashboardFilter() + ], + ), + file_name="result", + format="XLSX", + settings=DashboardExportSettings( + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + ), + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + description="description_example", + details=dict(), + evaluation_mode="SHARED", + external_recipients=[ + dict( + email="email_example", + ) + ], + image_exports=[ + dict( + request_payload=ImageExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PNG", + metadata=JsonNode(), + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + metadata=dict( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ) + ], + widget="widget_example", + ), + raw_exports=[ + dict( + request_payload=RawExportAutomationRequest( + custom_override=RawCustomOverride( + labels=dict( + "key": RawCustomLabel( + title="title_example", + ), + ), + metrics=dict( + "key": RawCustomMetric( + title="title_example", + ), + ), + ), + delimiter="U", + execution=AFM( + attributes=[ + AttributeItem() + ], +, + filters=[ + FilterDefinition() + ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=dict( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=dict( + id="sample_item.price", + type="attribute", + ), + ), + ) + ], + measures=[ + MeasureItem() + ], + ), + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp="1970-01-01T00:00:00.00Z", + ), + file_name="result", + format="CSV", + metadata=JsonNode(), + ), + ) + ], + schedule=dict( + cron="0 */30 9-17 ? * MON-FRI", + cron_description="cron_description_example", + first_run="2025-01-01T12:00Z", + timezone="Europe/Prague", + ), + slides_exports=[ + dict( + request_payload=SlidesExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + template_id="template_id_example", + visualization_ids=[ + "visualization_ids_example" + ], + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + state="ACTIVE", + tabular_exports=[ + dict( + request_payload=TabularExportRequest( + custom_override=CustomOverride( + labels=dict( + "key": CustomLabel(), + ), + metrics=dict( + "key": CustomMetric( + format="format_example", + title="title_example", + ), + ), + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + file_name="result", + format="CSV", + metadata=JsonNode(), + related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + settings=Settings( + delimiter="U", + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + pdf_page_size="a4 landscape", + pdf_table_style=[{"properties":[{"key":"font-size","value":"30px"}],"selector":"th"}], + pdf_top_left_content="Good", + pdf_top_right_content="Morning", + show_filters=False, + ), + visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", + visualization_object_custom_filters=[ + dict() + ], + ), + ) + ], + tags=[ + "tags_example" + ], + title="title_example", + visual_exports=[ + dict( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata=dict(), + ), + ) + ], + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + export_definitions=dict( + data=JsonApiExportDefinitionToManyLinkage([ + JsonApiExportDefinitionLinkage( + id="id_example", + type="exportDefinition", + ) + ]), + ), + notification_channel=dict( + data=JsonApiNotificationChannelToOneLinkage(None), + ), + recipients=dict( + data=JsonApiUserToManyLinkage([ + JsonApiUserLinkage( + id="id_example", + type="user", + ) + ]), + ), + ), + type="automation", + ), + ) + try: + # Post Automations + api_response = api_instance.create_entity_automations( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->create_entity_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationInDocument**](../../models/JsonApiAutomationInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationInDocument**](../../models/JsonApiAutomationInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +include | IncludeSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL", ] + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "all", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_entity_automations.ApiResponseFor201) | Request successfully processed + +#### create_entity_automations.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, SchemaFor201ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationOutDocument**](../../models/JsonApiAutomationOutDocument.md) | | + + +# SchemaFor201ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationOutDocument**](../../models/JsonApiAutomationOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_id) + +Delete an Automation + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_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(configuration) as api_client: + # Create an instance of the API class + api_instance = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + try: + # Delete an Automation + api_response = api_instance.delete_entity_automations( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->delete_entity_automations: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", + } + try: + # Delete an Automation + api_response = api_instance.delete_entity_automations( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->delete_entity_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_entity_automations.ApiResponseFor204) | Successfully deleted + +#### delete_entity_automations.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_organization_automations** + +> delete_organization_automations(organization_automation_management_bulk_request) + +Delete selected automations across all workspaces + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_api +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + body = OrganizationAutomationManagementBulkRequest( + automations=[ + OrganizationAutomationIdentifier( + id="id_example", + workspace_id="workspace_id_example", + ) + ], + ) + try: + # Delete selected automations across all workspaces + api_response = api_instance.delete_organization_automations( + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->delete_organization_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**OrganizationAutomationManagementBulkRequest**](../../models/OrganizationAutomationManagementBulkRequest.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_organization_automations.ApiResponseFor204) | No Content + +#### delete_organization_automations.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_workspace_automations** + +> delete_workspace_automations(workspace_idworkspace_automation_management_bulk_request) + +Delete selected automations in the workspace + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_api +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = WorkspaceAutomationManagementBulkRequest( + automations=[ + WorkspaceAutomationIdentifier( + id="id_example", + ) + ], + ) + try: + # Delete selected automations in the workspace + api_response = api_instance.delete_workspace_automations( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->delete_workspace_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**WorkspaceAutomationManagementBulkRequest**](../../models/WorkspaceAutomationManagementBulkRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_workspace_automations.ApiResponseFor204) | No Content + +#### delete_workspace_automations.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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() + +Get all Automations across all Workspaces + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automations_api.AutomationsApi(api_client) + + # example passing only optional values + query_params = { + 'filter': "title==someString;description==someString;workspace.id==321;notificationChannel.id==321", + 'include': [ + "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults" + ], + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=page,all" + ], + } + try: + # Get all Automations across all Workspaces + api_response = api_instance.get_all_automations_workspace_automations( + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->get_all_automations_workspace_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["workspaces", "notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "workspace", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL", ] + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["page", "all", "ALL", ] + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_automations_workspace_automations.ApiResponseFor200) | Request successfully processed + +#### get_all_automations_workspace_automations.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiWorkspaceAutomationOutList**](../../models/JsonApiWorkspaceAutomationOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiWorkspaceAutomationOutList**](../../models/JsonApiWorkspaceAutomationOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 Automations + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + header_params = { + } + try: + # Get all Automations + api_response = api_instance.get_all_entities_automations( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->get_all_entities_automations: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'origin': "ALL", + 'filter': "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", + 'include': [ + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults" + ], + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=origin,page,all" + ], + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + try: + # Get all Automations + api_response = api_instance.get_all_entities_automations( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->get_all_entities_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +origin | OriginSchema | | optional +filter | FilterSchema | | optional +include | IncludeSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# OriginSchema + +Defines scope of origin of objects. All by default. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Defines scope of origin of objects. All by default. | must be one of ["ALL", "PARENTS", "NATIVE", ] if omitted the server will use the default value of "ALL" + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL", ] + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "page", "all", "ALL", ] + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_entities_automations.ApiResponseFor200) | Request successfully processed + +#### get_all_entities_automations.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationOutList**](../../models/JsonApiAutomationOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationOutList**](../../models/JsonApiAutomationOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_automations** + +> [DeclarativeAutomation] get_automations(workspace_id) + +Get automations + +Retrieve automations for the specific workspace + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_api +from gooddata_api_client.model.declarative_automation import DeclarativeAutomation +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + try: + # Get automations + api_response = api_instance.get_automations( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->get_automations: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'exclude': [ + "ACTIVITY_INFO" + ], + } + try: + # Get automations + api_response = api_instance.get_automations( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->get_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +exclude | ExcludeSchema | | optional + + +# ExcludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Defines properties which should not be included in the payload. | must be one of ["ACTIVITY_INFO", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_automations.ApiResponseFor200) | Retrieved automations. + +#### get_automations.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DeclarativeAutomation**]({{complexTypePrefix}}DeclarativeAutomation.md) | [**DeclarativeAutomation**]({{complexTypePrefix}}DeclarativeAutomation.md) | [**DeclarativeAutomation**]({{complexTypePrefix}}DeclarativeAutomation.md) | | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_id) + +Get an Automation + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + header_params = { + } + try: + # Get an Automation + api_response = api_instance.get_entity_automations( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->get_entity_automations: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", + 'include': [ + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults" + ], + 'metaInclude': [ + "metaInclude=origin,all" + ], + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + try: + # Get an Automation + api_response = api_instance.get_entity_automations( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->get_entity_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL", ] + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "all", "ALL", ] + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_entity_automations.ApiResponseFor200) | Request successfully processed + +#### get_entity_automations.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationOutDocument**](../../models/JsonApiAutomationOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationOutDocument**](../../models/JsonApiAutomationOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_idjson_api_automation_patch_document) + +Patch an Automation + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_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(configuration) as api_client: + # Create an instance of the API class + api_instance = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + body = JsonApiAutomationPatchDocument( + data=JsonApiAutomationPatch( + attributes=dict( + alert=dict( + condition=AlertCondition(), + execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=dict( + id="sample_item.price", + type="label", + ), + ), + local_identifier="attribute_1", + show_all_values=False, + ) + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ) + ], + filters=[ + FilterDefinition() + ], + measures=[ + MeasureItem() + ], + ), + interval="DAY", + trigger="ALWAYS", + ), + are_relations_valid=True, + dashboard_tabular_exports=[ + dict( + request_payload=DashboardTabularExportRequestV2( + dashboard_filters_override=[ + DashboardFilter() + ], + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + dashboard_tabs_filters_overrides=dict( + "key": [ + DashboardFilter() + ], + ), + file_name="result", + format="XLSX", + settings=DashboardExportSettings( + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + ), + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + description="description_example", + details=dict(), + evaluation_mode="SHARED", + external_recipients=[ + dict( + email="email_example", + ) + ], + image_exports=[ + dict( + request_payload=ImageExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PNG", + metadata=JsonNode(), + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + metadata=dict( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ) + ], + widget="widget_example", + ), + raw_exports=[ + dict( + request_payload=RawExportAutomationRequest( + custom_override=RawCustomOverride( + labels=dict( + "key": RawCustomLabel( + title="title_example", + ), + ), + metrics=dict( + "key": RawCustomMetric( + title="title_example", + ), + ), + ), + delimiter="U", + execution=AFM( + attributes=[ + AttributeItem() + ], +, + filters=[ + FilterDefinition() + ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=dict( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=dict( + id="sample_item.price", + type="attribute", + ), + ), + ) + ], + measures=[ + MeasureItem() + ], + ), + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp="1970-01-01T00:00:00.00Z", + ), + file_name="result", + format="CSV", + metadata=JsonNode(), + ), + ) + ], + schedule=dict( + cron="0 */30 9-17 ? * MON-FRI", + cron_description="cron_description_example", + first_run="2025-01-01T12:00Z", + timezone="Europe/Prague", + ), + slides_exports=[ + dict( + request_payload=SlidesExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + template_id="template_id_example", + visualization_ids=[ + "visualization_ids_example" + ], + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + state="ACTIVE", + tabular_exports=[ + dict( + request_payload=TabularExportRequest( + custom_override=CustomOverride( + labels=dict( + "key": CustomLabel(), + ), + metrics=dict( + "key": CustomMetric( + format="format_example", + title="title_example", + ), + ), + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + file_name="result", + format="CSV", + metadata=JsonNode(), + related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + settings=Settings( + delimiter="U", + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + pdf_page_size="a4 landscape", + pdf_table_style=[{"properties":[{"key":"font-size","value":"30px"}],"selector":"th"}], + pdf_top_left_content="Good", + pdf_top_right_content="Morning", + show_filters=False, + ), + visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", + visualization_object_custom_filters=[ + dict() + ], + ), + ) + ], + tags=[ + "tags_example" + ], + title="title_example", + visual_exports=[ + dict( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata=dict(), + ), + ) + ], + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + export_definitions=dict( + data=JsonApiExportDefinitionToManyLinkage([ + JsonApiExportDefinitionLinkage( + id="id_example", + type="exportDefinition", + ) + ]), + ), + notification_channel=dict( + data=JsonApiNotificationChannelToOneLinkage(None), + ), + recipients=dict( + data=JsonApiUserToManyLinkage([ + JsonApiUserLinkage( + id="id_example", + type="user", + ) + ]), + ), + ), + type="automation", + ), + ) + try: + # Patch an Automation + api_response = api_instance.patch_entity_automations( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->patch_entity_automations: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", + 'include': [ + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults" + ], + } + body = JsonApiAutomationPatchDocument( + data=JsonApiAutomationPatch( + attributes=dict( + alert=dict( + condition=AlertCondition(), + execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=dict( + id="sample_item.price", + type="label", + ), + ), + local_identifier="attribute_1", + show_all_values=False, + ) + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ) + ], + filters=[ + FilterDefinition() + ], + measures=[ + MeasureItem() + ], + ), + interval="DAY", + trigger="ALWAYS", + ), + are_relations_valid=True, + dashboard_tabular_exports=[ + dict( + request_payload=DashboardTabularExportRequestV2( + dashboard_filters_override=[ + DashboardFilter() + ], + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + dashboard_tabs_filters_overrides=dict( + "key": [ + DashboardFilter() + ], + ), + file_name="result", + format="XLSX", + settings=DashboardExportSettings( + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + ), + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + description="description_example", + details=dict(), + evaluation_mode="SHARED", + external_recipients=[ + dict( + email="email_example", + ) + ], + image_exports=[ + dict( + request_payload=ImageExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PNG", + metadata=JsonNode(), + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + metadata=dict( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ) + ], + widget="widget_example", + ), + raw_exports=[ + dict( + request_payload=RawExportAutomationRequest( + custom_override=RawCustomOverride( + labels=dict( + "key": RawCustomLabel( + title="title_example", + ), + ), + metrics=dict( + "key": RawCustomMetric( + title="title_example", + ), + ), + ), + delimiter="U", + execution=AFM( + attributes=[ + AttributeItem() + ], +, + filters=[ + FilterDefinition() + ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=dict( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=dict( + id="sample_item.price", + type="attribute", + ), + ), + ) + ], + measures=[ + MeasureItem() + ], + ), + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp="1970-01-01T00:00:00.00Z", + ), + file_name="result", + format="CSV", + metadata=JsonNode(), + ), + ) + ], + schedule=dict( + cron="0 */30 9-17 ? * MON-FRI", + cron_description="cron_description_example", + first_run="2025-01-01T12:00Z", + timezone="Europe/Prague", + ), + slides_exports=[ + dict( + request_payload=SlidesExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + template_id="template_id_example", + visualization_ids=[ + "visualization_ids_example" + ], + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + state="ACTIVE", + tabular_exports=[ + dict( + request_payload=TabularExportRequest( + custom_override=CustomOverride( + labels=dict( + "key": CustomLabel(), + ), + metrics=dict( + "key": CustomMetric( + format="format_example", + title="title_example", + ), + ), + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + file_name="result", + format="CSV", + metadata=JsonNode(), + related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + settings=Settings( + delimiter="U", + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + pdf_page_size="a4 landscape", + pdf_table_style=[{"properties":[{"key":"font-size","value":"30px"}],"selector":"th"}], + pdf_top_left_content="Good", + pdf_top_right_content="Morning", + show_filters=False, + ), + visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", + visualization_object_custom_filters=[ + dict() + ], + ), + ) + ], + tags=[ + "tags_example" + ], + title="title_example", + visual_exports=[ + dict( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata=dict(), + ), + ) + ], + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + export_definitions=dict( + data=JsonApiExportDefinitionToManyLinkage([ + JsonApiExportDefinitionLinkage( + id="id_example", + type="exportDefinition", + ) + ]), + ), + notification_channel=dict( + data=JsonApiNotificationChannelToOneLinkage(None), + ), + recipients=dict( + data=JsonApiUserToManyLinkage([ + JsonApiUserLinkage( + id="id_example", + type="user", + ) + ]), + ), + ), + type="automation", + ), + ) + try: + # Patch an Automation + api_response = api_instance.patch_entity_automations( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->patch_entity_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationPatchDocument**](../../models/JsonApiAutomationPatchDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationPatchDocument**](../../models/JsonApiAutomationPatchDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#patch_entity_automations.ApiResponseFor200) | Request successfully processed + +#### patch_entity_automations.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationOutDocument**](../../models/JsonApiAutomationOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationOutDocument**](../../models/JsonApiAutomationOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **pause_organization_automations** + +> pause_organization_automations(organization_automation_management_bulk_request) + +Pause selected automations across all workspaces + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_api +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + body = OrganizationAutomationManagementBulkRequest( + automations=[ + OrganizationAutomationIdentifier( + id="id_example", + workspace_id="workspace_id_example", + ) + ], + ) + try: + # Pause selected automations across all workspaces + api_response = api_instance.pause_organization_automations( + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->pause_organization_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**OrganizationAutomationManagementBulkRequest**](../../models/OrganizationAutomationManagementBulkRequest.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#pause_organization_automations.ApiResponseFor204) | No Content + +#### pause_organization_automations.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **pause_workspace_automations** + +> pause_workspace_automations(workspace_idworkspace_automation_management_bulk_request) + +Pause selected automations in the workspace + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_api +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = WorkspaceAutomationManagementBulkRequest( + automations=[ + WorkspaceAutomationIdentifier( + id="id_example", + ) + ], + ) + try: + # Pause selected automations in the workspace + api_response = api_instance.pause_workspace_automations( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->pause_workspace_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**WorkspaceAutomationManagementBulkRequest**](../../models/WorkspaceAutomationManagementBulkRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#pause_workspace_automations.ApiResponseFor204) | No Content + +#### pause_workspace_automations.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_automation_results** + +> JsonApiAutomationResultOutList search_entities_automation_results(workspace_identity_search_body) + +Search request for AutomationResult + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_api +from gooddata_api_client.model.json_api_automation_result_out_list import JsonApiAutomationResultOutList +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(configuration) as api_client: + # Create an instance of the API class + api_instance = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + header_params = { + } + 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", + ) + ], + ) + try: + # Search request for AutomationResult + api_response = api_instance.search_entities_automation_results( + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->search_entities_automation_results: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'origin': "ALL", + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + 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", + ) + ], + ) + try: + # Search request for AutomationResult + api_response = api_instance.search_entities_automation_results( + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->search_entities_automation_results: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**EntitySearchBody**](../../models/EntitySearchBody.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +origin | OriginSchema | | optional + + +# OriginSchema + +Defines scope of origin of objects. All by default. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Defines scope of origin of objects. All by default. | must be one of ["ALL", "PARENTS", "NATIVE", ] if omitted the server will use the default value of "ALL" + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#search_entities_automation_results.ApiResponseFor200) | Request successfully processed + +#### search_entities_automation_results.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationResultOutList**](../../models/JsonApiAutomationResultOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationResultOutList**](../../models/JsonApiAutomationResultOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_automations** + +> JsonApiAutomationOutList search_entities_automations(workspace_identity_search_body) + +Search request for Automation + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_api +from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList +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(configuration) as api_client: + # Create an instance of the API class + api_instance = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + header_params = { + } + 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", + ) + ], + ) + try: + # Search request for Automation + api_response = api_instance.search_entities_automations( + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->search_entities_automations: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'origin': "ALL", + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + 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", + ) + ], + ) + try: + # Search request for Automation + api_response = api_instance.search_entities_automations( + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->search_entities_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**EntitySearchBody**](../../models/EntitySearchBody.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +origin | OriginSchema | | optional + + +# OriginSchema + +Defines scope of origin of objects. All by default. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Defines scope of origin of objects. All by default. | must be one of ["ALL", "PARENTS", "NATIVE", ] if omitted the server will use the default value of "ALL" + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#search_entities_automations.ApiResponseFor200) | Request successfully processed + +#### search_entities_automations.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationOutList**](../../models/JsonApiAutomationOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationOutList**](../../models/JsonApiAutomationOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **set_automations** + +> set_automations(workspace_iddeclarative_automation) + +Set automations + +Set automations for the specific workspace. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_api +from gooddata_api_client.model.declarative_automation import DeclarativeAutomation +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = [ + DeclarativeAutomation( + alert=AutomationAlert( + condition=None, + execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=dict( + id="sample_item.price", + type="label", + ), + ), + local_identifier="attribute_1", + show_all_values=False, + ) + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ) + ], + filters=[ + FilterDefinition() + ], + measures=[ + MeasureItem() + ], + ), + interval="DAY", + trigger="ALWAYS", + ), + analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( + id="dashboard123", + type="analyticalDashboard", + ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + dashboard_tabular_exports=[ + AutomationDashboardTabularExport( + request_payload=DashboardTabularExportRequestV2( + dashboard_filters_override=[ + DashboardFilter() + ], + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + dashboard_tabs_filters_overrides=dict( + "key": [ + DashboardFilter() + ], + ), + file_name="result", + format="XLSX", + settings=DashboardExportSettings( + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + ), + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + description="description_example", + details=dict( + "key": "key_example", + ), + evaluation_mode="PER_RECIPIENT", + export_definitions=[ + DeclarativeExportDefinitionIdentifier( + id="export123", + type="exportDefinition", + ) + ], + external_recipients=[ + AutomationExternalRecipient( + email="email_example", + ) + ], + id="/6bUUGjjNSwg0_bs", + image_exports=[ + AutomationImageExport( + request_payload=ImageExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PNG", + metadata=JsonNode(), + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ) + ], + widget="widget_example", + ), + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier(), + notification_channel=DeclarativeNotificationChannelIdentifier( + id="webhook123", + type="notificationChannel", + ), + raw_exports=[ + AutomationRawExport( + request_payload=RawExportAutomationRequest( + custom_override=RawCustomOverride( + labels=dict( + "key": RawCustomLabel( + title="title_example", + ), + ), + metrics=dict( + "key": RawCustomMetric( + title="title_example", + ), + ), + ), + delimiter="U", + execution=AFM( + attributes=[ + AttributeItem() + ], +, + filters=[ + FilterDefinition() + ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=dict( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=dict( + id="sample_item.price", + type="attribute", + ), + ), + ) + ], + measures=[ + MeasureItem() + ], + ), + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp="1970-01-01T00:00:00.00Z", + ), + file_name="result", + format="CSV", + metadata=JsonNode(), + ), + ) + ], + recipients=[ + DeclarativeUserIdentifier() + ], + schedule=AutomationSchedule( + cron="0 */30 9-17 ? * MON-FRI", + cron_description="cron_description_example", + first_run="2025-01-01T12:00Z", + timezone="Europe/Prague", + ), + slides_exports=[ + AutomationSlidesExport( + request_payload=SlidesExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + template_id="template_id_example", + visualization_ids=[ + "visualization_ids_example" + ], + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + state="ACTIVE", + tabular_exports=[ + AutomationTabularExport( + request_payload=TabularExportRequest( + custom_override=CustomOverride( + labels=dict( + "key": CustomLabel(), + ), + metrics=dict( + "key": CustomMetric( + format="format_example", + title="title_example", + ), + ), + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + file_name="result", + format="CSV", + metadata=JsonNode(), + related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + settings=Settings( + delimiter="U", + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + pdf_page_size="a4 landscape", + pdf_table_style=[{"properties":[{"key":"font-size","value":"30px"}],"selector":"th"}], + pdf_top_left_content="Good", + pdf_top_right_content="Morning", + show_filters=False, + ), + visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", + visualization_object_custom_filters=[ + dict() + ], + ), + ) + ], + tags=[ + "[\"Revenue\",\"Sales\"]" + ], + title="title_example", + visual_exports=[ + AutomationVisualExport( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata=dict(), + ), + ) + ], + ) + ] + try: + # Set automations + api_response = api_instance.set_automations( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->set_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DeclarativeAutomation**]({{complexTypePrefix}}DeclarativeAutomation.md) | [**DeclarativeAutomation**]({{complexTypePrefix}}DeclarativeAutomation.md) | [**DeclarativeAutomation**]({{complexTypePrefix}}DeclarativeAutomation.md) | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#set_automations.ApiResponseFor204) | Automations successfully set. + +#### set_automations.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **trigger_automation** + +> trigger_automation(workspace_idtrigger_automation_request) + +Trigger automation. + +Trigger the automation in the request. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_api +from gooddata_api_client.model.trigger_automation_request import TriggerAutomationRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = TriggerAutomationRequest( + automation=AdHocAutomation( + alert=AutomationAlert( + condition=None, + execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=dict( + id="sample_item.price", + type="label", + ), + ), + local_identifier="attribute_1", + show_all_values=False, + ) + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ) + ], + filters=[ + FilterDefinition() + ], + measures=[ + MeasureItem() + ], + ), + interval="DAY", + trigger="ALWAYS", + ), + analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( + id="dashboard123", + type="analyticalDashboard", + ), + dashboard_tabular_exports=[ + AutomationDashboardTabularExport( + request_payload=DashboardTabularExportRequestV2( + dashboard_filters_override=[ + DashboardFilter() + ], + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + dashboard_tabs_filters_overrides=dict( + "key": [ + DashboardFilter() + ], + ), + file_name="result", + format="XLSX", + settings=DashboardExportSettings( + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + ), + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + description="description_example", + details=dict( + "key": "key_example", + ), + external_recipients=[ + AutomationExternalRecipient( + email="email_example", + ) + ], + image_exports=[ + AutomationImageExport( + request_payload=ImageExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PNG", + metadata=JsonNode(), + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ) + ], + widget="widget_example", + ), + notification_channel=DeclarativeNotificationChannelIdentifier( + id="webhook123", + type="notificationChannel", + ), + raw_exports=[ + AutomationRawExport( + request_payload=RawExportAutomationRequest( + custom_override=RawCustomOverride( + labels=dict( + "key": RawCustomLabel( + title="title_example", + ), + ), + metrics=dict( + "key": RawCustomMetric( + title="title_example", + ), + ), + ), + delimiter="U", + execution=AFM( + attributes=[ + AttributeItem() + ], +, + filters=[ + FilterDefinition() + ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=dict( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=dict( + id="sample_item.price", + type="attribute", + ), + ), + ) + ], + measures=[ + MeasureItem() + ], + ), + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp="1970-01-01T00:00:00.00Z", + ), + file_name="result", + format="CSV", + metadata=JsonNode(), + ), + ) + ], + recipients=[ + DeclarativeUserIdentifier( + id="employee123", + type="user", + ) + ], + slides_exports=[ + AutomationSlidesExport( + request_payload=SlidesExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + template_id="template_id_example", + visualization_ids=[ + "visualization_ids_example" + ], + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + tabular_exports=[ + AutomationTabularExport( + request_payload=TabularExportRequest( + custom_override=CustomOverride( + labels=dict( + "key": CustomLabel(), + ), + metrics=dict( + "key": CustomMetric( + format="format_example", + title="title_example", + ), + ), + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + file_name="result", + format="CSV", + metadata=JsonNode(), + related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + settings=Settings( + delimiter="U", + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + pdf_page_size="a4 landscape", + pdf_table_style=[{"properties":[{"key":"font-size","value":"30px"}],"selector":"th"}], + pdf_top_left_content="Good", + pdf_top_right_content="Morning", + show_filters=False, + ), + visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", + visualization_object_custom_filters=[ + dict() + ], + ), + ) + ], + tags=["Revenue","Sales"], + title="title_example", + visual_exports=[ + AutomationVisualExport( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata=dict(), + ), + ) + ], + ), + ) + try: + # Trigger automation. + api_response = api_instance.trigger_automation( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->trigger_automation: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**TriggerAutomationRequest**](../../models/TriggerAutomationRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#trigger_automation.ApiResponseFor204) | The automation is successfully triggered. + +#### trigger_automation.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **trigger_existing_automation** + +> trigger_existing_automation(workspace_idautomation_id) + +Trigger existing automation. + +Trigger the existing automation to execute immediately. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_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(configuration) as api_client: + # Create an instance of the API class + api_instance = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'automationId': "automationId_example", + } + try: + # Trigger existing automation. + api_response = api_instance.trigger_existing_automation( + path_params=path_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->trigger_existing_automation: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +automationId | AutomationIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# AutomationIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#trigger_existing_automation.ApiResponseFor204) | The automation is successfully triggered. + +#### trigger_existing_automation.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **unpause_organization_automations** + +> unpause_organization_automations(organization_automation_management_bulk_request) + +Unpause selected automations across all workspaces + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_api +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + body = OrganizationAutomationManagementBulkRequest( + automations=[ + OrganizationAutomationIdentifier( + id="id_example", + workspace_id="workspace_id_example", + ) + ], + ) + try: + # Unpause selected automations across all workspaces + api_response = api_instance.unpause_organization_automations( + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->unpause_organization_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**OrganizationAutomationManagementBulkRequest**](../../models/OrganizationAutomationManagementBulkRequest.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#unpause_organization_automations.ApiResponseFor204) | No Content + +#### unpause_organization_automations.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **unpause_workspace_automations** + +> unpause_workspace_automations(workspace_idworkspace_automation_management_bulk_request) + +Unpause selected automations in the workspace + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_api +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = WorkspaceAutomationManagementBulkRequest( + automations=[ + WorkspaceAutomationIdentifier( + id="id_example", + ) + ], + ) + try: + # Unpause selected automations in the workspace + api_response = api_instance.unpause_workspace_automations( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->unpause_workspace_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**WorkspaceAutomationManagementBulkRequest**](../../models/WorkspaceAutomationManagementBulkRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#unpause_workspace_automations.ApiResponseFor204) | No Content + +#### unpause_workspace_automations.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **unsubscribe_all_automations** + +> unsubscribe_all_automations() + +Unsubscribe from all automations in all workspaces + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_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(configuration) as api_client: + # Create an instance of the API class + api_instance = automations_api.AutomationsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Unsubscribe from all automations in all workspaces + api_response = api_instance.unsubscribe_all_automations() + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->unsubscribe_all_automations: %s\n" % e) +``` +### Parameters +This endpoint does not need any parameter. + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#unsubscribe_all_automations.ApiResponseFor204) | No Content + +#### unsubscribe_all_automations.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **unsubscribe_automation** + +> unsubscribe_automation(workspace_idautomation_id) + +Unsubscribe from an automation + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_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(configuration) as api_client: + # Create an instance of the API class + api_instance = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'automationId': "automationId_example", + } + try: + # Unsubscribe from an automation + api_response = api_instance.unsubscribe_automation( + path_params=path_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->unsubscribe_automation: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +automationId | AutomationIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# AutomationIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#unsubscribe_automation.ApiResponseFor204) | No Content + +#### unsubscribe_automation.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **unsubscribe_organization_automations** + +> unsubscribe_organization_automations(organization_automation_management_bulk_request) + +Unsubscribe from selected automations across all workspaces + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_api +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + body = OrganizationAutomationManagementBulkRequest( + automations=[ + OrganizationAutomationIdentifier( + id="id_example", + workspace_id="workspace_id_example", + ) + ], + ) + try: + # Unsubscribe from selected automations across all workspaces + api_response = api_instance.unsubscribe_organization_automations( + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->unsubscribe_organization_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**OrganizationAutomationManagementBulkRequest**](../../models/OrganizationAutomationManagementBulkRequest.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#unsubscribe_organization_automations.ApiResponseFor204) | No Content + +#### unsubscribe_organization_automations.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **unsubscribe_selected_workspace_automations** + +> unsubscribe_selected_workspace_automations(workspace_idworkspace_automation_management_bulk_request) + +Unsubscribe from selected automations in the workspace + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_api +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = WorkspaceAutomationManagementBulkRequest( + automations=[ + WorkspaceAutomationIdentifier( + id="id_example", + ) + ], + ) + try: + # Unsubscribe from selected automations in the workspace + api_response = api_instance.unsubscribe_selected_workspace_automations( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->unsubscribe_selected_workspace_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**WorkspaceAutomationManagementBulkRequest**](../../models/WorkspaceAutomationManagementBulkRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#unsubscribe_selected_workspace_automations.ApiResponseFor204) | No Content + +#### unsubscribe_selected_workspace_automations.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **unsubscribe_workspace_automations** + +> unsubscribe_workspace_automations(workspace_id) + +Unsubscribe from all automations in the workspace + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_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(configuration) as api_client: + # Create an instance of the API class + api_instance = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + try: + # Unsubscribe from all automations in the workspace + api_response = api_instance.unsubscribe_workspace_automations( + path_params=path_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->unsubscribe_workspace_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#unsubscribe_workspace_automations.ApiResponseFor204) | No Content + +#### unsubscribe_workspace_automations.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_automations** + +> JsonApiAutomationOutDocument update_entity_automations(workspace_idobject_idjson_api_automation_in_document) + +Put an Automation + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import automations_api +from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = automations_api.AutomationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + body = JsonApiAutomationInDocument( + data=JsonApiAutomationIn( + attributes=dict( + alert=dict( + condition=AlertCondition(), + execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=dict( + id="sample_item.price", + type="label", + ), + ), + local_identifier="attribute_1", + show_all_values=False, + ) + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ) + ], + filters=[ + FilterDefinition() + ], + measures=[ + MeasureItem() + ], + ), + interval="DAY", + trigger="ALWAYS", + ), + are_relations_valid=True, + dashboard_tabular_exports=[ + dict( + request_payload=DashboardTabularExportRequestV2( + dashboard_filters_override=[ + DashboardFilter() + ], + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + dashboard_tabs_filters_overrides=dict( + "key": [ + DashboardFilter() + ], + ), + file_name="result", + format="XLSX", + settings=DashboardExportSettings( + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + ), + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + description="description_example", + details=dict(), + evaluation_mode="SHARED", + external_recipients=[ + dict( + email="email_example", + ) + ], + image_exports=[ + dict( + request_payload=ImageExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PNG", + metadata=JsonNode(), + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + metadata=dict( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ) + ], + widget="widget_example", + ), + raw_exports=[ + dict( + request_payload=RawExportAutomationRequest( + custom_override=RawCustomOverride( + labels=dict( + "key": RawCustomLabel( + title="title_example", + ), + ), + metrics=dict( + "key": RawCustomMetric( + title="title_example", + ), + ), + ), + delimiter="U", + execution=AFM( + attributes=[ + AttributeItem() + ], +, + filters=[ + FilterDefinition() + ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=dict( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=dict( + id="sample_item.price", + type="attribute", + ), + ), + ) + ], + measures=[ + MeasureItem() + ], + ), + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp="1970-01-01T00:00:00.00Z", + ), + file_name="result", + format="CSV", + metadata=JsonNode(), + ), + ) + ], + schedule=dict( + cron="0 */30 9-17 ? * MON-FRI", + cron_description="cron_description_example", + first_run="2025-01-01T12:00Z", + timezone="Europe/Prague", + ), + slides_exports=[ + dict( + request_payload=SlidesExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + template_id="template_id_example", + visualization_ids=[ + "visualization_ids_example" + ], + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + state="ACTIVE", + tabular_exports=[ + dict( + request_payload=TabularExportRequest( + custom_override=CustomOverride( + labels=dict( + "key": CustomLabel(), + ), + metrics=dict( + "key": CustomMetric( + format="format_example", + title="title_example", + ), + ), + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + file_name="result", + format="CSV", + metadata=JsonNode(), + related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + settings=Settings( + delimiter="U", + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + pdf_page_size="a4 landscape", + pdf_table_style=[{"properties":[{"key":"font-size","value":"30px"}],"selector":"th"}], + pdf_top_left_content="Good", + pdf_top_right_content="Morning", + show_filters=False, + ), + visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", + visualization_object_custom_filters=[ + dict() + ], + ), + ) + ], + tags=[ + "tags_example" + ], + title="title_example", + visual_exports=[ + dict( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata=dict(), + ), + ) + ], + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + export_definitions=dict( + data=JsonApiExportDefinitionToManyLinkage([ + JsonApiExportDefinitionLinkage( + id="id_example", + type="exportDefinition", + ) + ]), + ), + notification_channel=dict( + data=JsonApiNotificationChannelToOneLinkage(None), + ), + recipients=dict( + data=JsonApiUserToManyLinkage([ + JsonApiUserLinkage( + id="id_example", + type="user", + ) + ]), + ), + ), + type="automation", + ), + ) + try: + # Put an Automation + api_response = api_instance.update_entity_automations( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->update_entity_automations: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", + 'include': [ + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults" + ], + } + body = JsonApiAutomationInDocument( + data=JsonApiAutomationIn( + attributes=dict( + alert=dict( + condition=AlertCondition(), + execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=dict( + id="sample_item.price", + type="label", + ), + ), + local_identifier="attribute_1", + show_all_values=False, + ) + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ) + ], + filters=[ + FilterDefinition() + ], + measures=[ + MeasureItem() + ], + ), + interval="DAY", + trigger="ALWAYS", + ), + are_relations_valid=True, + dashboard_tabular_exports=[ + dict( + request_payload=DashboardTabularExportRequestV2( + dashboard_filters_override=[ + DashboardFilter() + ], + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + dashboard_tabs_filters_overrides=dict( + "key": [ + DashboardFilter() + ], + ), + file_name="result", + format="XLSX", + settings=DashboardExportSettings( + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + ), + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + description="description_example", + details=dict(), + evaluation_mode="SHARED", + external_recipients=[ + dict( + email="email_example", + ) + ], + image_exports=[ + dict( + request_payload=ImageExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PNG", + metadata=JsonNode(), + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + metadata=dict( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ) + ], + widget="widget_example", + ), + raw_exports=[ + dict( + request_payload=RawExportAutomationRequest( + custom_override=RawCustomOverride( + labels=dict( + "key": RawCustomLabel( + title="title_example", + ), + ), + metrics=dict( + "key": RawCustomMetric( + title="title_example", + ), + ), + ), + delimiter="U", + execution=AFM( + attributes=[ + AttributeItem() + ], +, + filters=[ + FilterDefinition() + ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=dict( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=dict( + id="sample_item.price", + type="attribute", + ), + ), + ) + ], + measures=[ + MeasureItem() + ], + ), + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp="1970-01-01T00:00:00.00Z", + ), + file_name="result", + format="CSV", + metadata=JsonNode(), + ), + ) + ], + schedule=dict( + cron="0 */30 9-17 ? * MON-FRI", + cron_description="cron_description_example", + first_run="2025-01-01T12:00Z", + timezone="Europe/Prague", + ), + slides_exports=[ + dict( + request_payload=SlidesExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + template_id="template_id_example", + visualization_ids=[ + "visualization_ids_example" + ], + widget_ids=[ + "widget_ids_example" + ], + ), + ) + ], + state="ACTIVE", + tabular_exports=[ + dict( + request_payload=TabularExportRequest( + custom_override=CustomOverride( + labels=dict( + "key": CustomLabel(), + ), + metrics=dict( + "key": CustomMetric( + format="format_example", + title="title_example", + ), + ), + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + file_name="result", + format="CSV", + metadata=JsonNode(), + related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + settings=Settings( + delimiter="U", + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + pdf_page_size="a4 landscape", + pdf_table_style=[{"properties":[{"key":"font-size","value":"30px"}],"selector":"th"}], + pdf_top_left_content="Good", + pdf_top_right_content="Morning", + show_filters=False, + ), + visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", + visualization_object_custom_filters=[ + dict() + ], + ), + ) + ], + tags=[ + "tags_example" + ], + title="title_example", + visual_exports=[ + dict( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata=dict(), + ), + ) + ], + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + export_definitions=dict( + data=JsonApiExportDefinitionToManyLinkage([ + JsonApiExportDefinitionLinkage( + id="id_example", + type="exportDefinition", + ) + ]), + ), + notification_channel=dict( + data=JsonApiNotificationChannelToOneLinkage(None), + ), + recipients=dict( + data=JsonApiUserToManyLinkage([ + JsonApiUserLinkage( + id="id_example", + type="user", + ) + ]), + ), + ), + type="automation", + ), + ) + try: + # Put an Automation + api_response = api_instance.update_entity_automations( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AutomationsApi->update_entity_automations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationInDocument**](../../models/JsonApiAutomationInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationInDocument**](../../models/JsonApiAutomationInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#update_entity_automations.ApiResponseFor200) | Request successfully processed + +#### update_entity_automations.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationOutDocument**](../../models/JsonApiAutomationOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiAutomationOutDocument**](../../models/JsonApiAutomationOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/CertificationApi.md b/gooddata-api-client/docs/apis/tags/CertificationApi.md new file mode 100644 index 000000000..5f7e836be --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/CertificationApi.md @@ -0,0 +1,107 @@ + +# gooddata_api_client.apis.tags.certification_api.CertificationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**set_certification**](#set_certification) | **post** /api/v1/actions/workspaces/{workspaceId}/setCertification | Set Certification + +# **set_certification** + +> set_certification(workspace_idset_certification_request) + +Set Certification + +Set or clear the certification (e.g. CERTIFIED) of a workspace entity. Requires MANAGE permission. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import certification_api +from gooddata_api_client.model.set_certification_request import SetCertificationRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = certification_api.CertificationApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = SetCertificationRequest( + id="total-sales", + message="message_example", + status="CERTIFIED", + type="metric", + ) + try: + # Set Certification + api_response = api_instance.set_certification( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling CertificationApi->set_certification: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**SetCertificationRequest**](../../models/SetCertificationRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#set_certification.ApiResponseFor204) | No Content + +#### set_certification.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/ExportDefinitionsApi.md b/gooddata-api-client/docs/apis/tags/ExportDefinitionsApi.md new file mode 100644 index 000000000..37e7a3cc2 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/ExportDefinitionsApi.md @@ -0,0 +1,1426 @@ + +# gooddata_api_client.apis.tags.export_definitions_api.ExportDefinitionsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_export_definitions**](#create_entity_export_definitions) | **post** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Post Export Definitions +[**delete_entity_export_definitions**](#delete_entity_export_definitions) | **delete** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Delete an Export Definition +[**get_all_entities_export_definitions**](#get_all_entities_export_definitions) | **get** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Get all Export Definitions +[**get_entity_export_definitions**](#get_entity_export_definitions) | **get** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Get an Export Definition +[**patch_entity_export_definitions**](#patch_entity_export_definitions) | **patch** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition +[**search_entities_export_definitions**](#search_entities_export_definitions) | **post** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | Search request for ExportDefinition +[**update_entity_export_definitions**](#update_entity_export_definitions) | **put** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition + +# **create_entity_export_definitions** + +> JsonApiExportDefinitionOutDocument create_entity_export_definitions(workspace_idjson_api_export_definition_post_optional_id_document) + +Post Export Definitions + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import export_definitions_api +from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = export_definitions_api.ExportDefinitionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + body = JsonApiExportDefinitionPostOptionalIdDocument( + data=JsonApiExportDefinitionPostOptionalId( + attributes=dict( + are_relations_valid=True, + description="description_example", + request_payload=dict(), + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + visualization_object=dict( + data=JsonApiVisualizationObjectToOneLinkage(None), + ), + ), + type="exportDefinition", + ), + ) + try: + # Post Export Definitions + api_response = api_instance.create_entity_export_definitions( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionsApi->create_entity_export_definitions: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'include': [ + "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy" + ], + 'metaInclude': [ + "metaInclude=origin,all" + ], + } + body = JsonApiExportDefinitionPostOptionalIdDocument( + data=JsonApiExportDefinitionPostOptionalId( + attributes=dict( + are_relations_valid=True, + description="description_example", + request_payload=dict(), + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + visualization_object=dict( + data=JsonApiVisualizationObjectToOneLinkage(None), + ), + ), + type="exportDefinition", + ), + ) + try: + # Post Export Definitions + api_response = api_instance.create_entity_export_definitions( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionsApi->create_entity_export_definitions: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionPostOptionalIdDocument**](../../models/JsonApiExportDefinitionPostOptionalIdDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionPostOptionalIdDocument**](../../models/JsonApiExportDefinitionPostOptionalIdDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +include | IncludeSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["visualizationObjects", "analyticalDashboards", "automations", "userIdentifiers", "visualizationObject", "analyticalDashboard", "automation", "createdBy", "modifiedBy", "ALL", ] + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "all", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_entity_export_definitions.ApiResponseFor201) | Request successfully processed + +#### create_entity_export_definitions.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, SchemaFor201ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionOutDocument**](../../models/JsonApiExportDefinitionOutDocument.md) | | + + +# SchemaFor201ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionOutDocument**](../../models/JsonApiExportDefinitionOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_id) + +Delete an Export Definition + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import export_definitions_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(configuration) as api_client: + # Create an instance of the API class + api_instance = export_definitions_api.ExportDefinitionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + try: + # Delete an Export Definition + api_response = api_instance.delete_entity_export_definitions( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionsApi->delete_entity_export_definitions: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", + } + try: + # Delete an Export Definition + api_response = api_instance.delete_entity_export_definitions( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionsApi->delete_entity_export_definitions: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_entity_export_definitions.ApiResponseFor204) | Successfully deleted + +#### delete_entity_export_definitions.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 Export Definitions + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import export_definitions_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = export_definitions_api.ExportDefinitionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + header_params = { + } + try: + # Get all Export Definitions + api_response = api_instance.get_all_entities_export_definitions( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionsApi->get_all_entities_export_definitions: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'origin': "ALL", + 'filter': "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", + 'include': [ + "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy" + ], + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=origin,page,all" + ], + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + try: + # Get all Export Definitions + api_response = api_instance.get_all_entities_export_definitions( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionsApi->get_all_entities_export_definitions: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +origin | OriginSchema | | optional +filter | FilterSchema | | optional +include | IncludeSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# OriginSchema + +Defines scope of origin of objects. All by default. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Defines scope of origin of objects. All by default. | must be one of ["ALL", "PARENTS", "NATIVE", ] if omitted the server will use the default value of "ALL" + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["visualizationObjects", "analyticalDashboards", "automations", "userIdentifiers", "visualizationObject", "analyticalDashboard", "automation", "createdBy", "modifiedBy", "ALL", ] + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "page", "all", "ALL", ] + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_entities_export_definitions.ApiResponseFor200) | Request successfully processed + +#### get_all_entities_export_definitions.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionOutList**](../../models/JsonApiExportDefinitionOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionOutList**](../../models/JsonApiExportDefinitionOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_id) + +Get an Export Definition + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import export_definitions_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = export_definitions_api.ExportDefinitionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + header_params = { + } + try: + # Get an Export Definition + api_response = api_instance.get_entity_export_definitions( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionsApi->get_entity_export_definitions: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", + 'include': [ + "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy" + ], + 'metaInclude': [ + "metaInclude=origin,all" + ], + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + try: + # Get an Export Definition + api_response = api_instance.get_entity_export_definitions( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionsApi->get_entity_export_definitions: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["visualizationObjects", "analyticalDashboards", "automations", "userIdentifiers", "visualizationObject", "analyticalDashboard", "automation", "createdBy", "modifiedBy", "ALL", ] + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "all", "ALL", ] + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_entity_export_definitions.ApiResponseFor200) | Request successfully processed + +#### get_entity_export_definitions.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionOutDocument**](../../models/JsonApiExportDefinitionOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionOutDocument**](../../models/JsonApiExportDefinitionOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_idjson_api_export_definition_patch_document) + +Patch an Export Definition + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import export_definitions_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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = export_definitions_api.ExportDefinitionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + body = JsonApiExportDefinitionPatchDocument( + data=JsonApiExportDefinitionPatch( + attributes=dict( + are_relations_valid=True, + description="description_example", + request_payload=dict(), + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + visualization_object=dict( + data=JsonApiVisualizationObjectToOneLinkage(None), + ), + ), + type="exportDefinition", + ), + ) + try: + # Patch an Export Definition + api_response = api_instance.patch_entity_export_definitions( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionsApi->patch_entity_export_definitions: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", + 'include': [ + "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy" + ], + } + body = JsonApiExportDefinitionPatchDocument( + data=JsonApiExportDefinitionPatch( + attributes=dict( + are_relations_valid=True, + description="description_example", + request_payload=dict(), + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + visualization_object=dict( + data=JsonApiVisualizationObjectToOneLinkage(None), + ), + ), + type="exportDefinition", + ), + ) + try: + # Patch an Export Definition + api_response = api_instance.patch_entity_export_definitions( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionsApi->patch_entity_export_definitions: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionPatchDocument**](../../models/JsonApiExportDefinitionPatchDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionPatchDocument**](../../models/JsonApiExportDefinitionPatchDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["visualizationObjects", "analyticalDashboards", "automations", "userIdentifiers", "visualizationObject", "analyticalDashboard", "automation", "createdBy", "modifiedBy", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#patch_entity_export_definitions.ApiResponseFor200) | Request successfully processed + +#### patch_entity_export_definitions.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionOutDocument**](../../models/JsonApiExportDefinitionOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionOutDocument**](../../models/JsonApiExportDefinitionOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_export_definitions** + +> JsonApiExportDefinitionOutList search_entities_export_definitions(workspace_identity_search_body) + +Search request for ExportDefinition + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import export_definitions_api +from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +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(configuration) as api_client: + # Create an instance of the API class + api_instance = export_definitions_api.ExportDefinitionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + header_params = { + } + 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", + ) + ], + ) + try: + # Search request for ExportDefinition + api_response = api_instance.search_entities_export_definitions( + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionsApi->search_entities_export_definitions: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'origin': "ALL", + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + 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", + ) + ], + ) + try: + # Search request for ExportDefinition + api_response = api_instance.search_entities_export_definitions( + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionsApi->search_entities_export_definitions: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**EntitySearchBody**](../../models/EntitySearchBody.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +origin | OriginSchema | | optional + + +# OriginSchema + +Defines scope of origin of objects. All by default. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Defines scope of origin of objects. All by default. | must be one of ["ALL", "PARENTS", "NATIVE", ] if omitted the server will use the default value of "ALL" + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#search_entities_export_definitions.ApiResponseFor200) | Request successfully processed + +#### search_entities_export_definitions.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionOutList**](../../models/JsonApiExportDefinitionOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionOutList**](../../models/JsonApiExportDefinitionOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **update_entity_export_definitions** + +> JsonApiExportDefinitionOutDocument update_entity_export_definitions(workspace_idobject_idjson_api_export_definition_in_document) + +Put an Export Definition + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import export_definitions_api +from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.model.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = export_definitions_api.ExportDefinitionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + body = JsonApiExportDefinitionInDocument( + data=JsonApiExportDefinitionIn( + attributes=dict( + are_relations_valid=True, + description="description_example", + request_payload=dict(), + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + visualization_object=dict( + data=JsonApiVisualizationObjectToOneLinkage(None), + ), + ), + type="exportDefinition", + ), + ) + try: + # Put an Export Definition + api_response = api_instance.update_entity_export_definitions( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionsApi->update_entity_export_definitions: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", + 'include': [ + "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy" + ], + } + body = JsonApiExportDefinitionInDocument( + data=JsonApiExportDefinitionIn( + attributes=dict( + are_relations_valid=True, + description="description_example", + request_payload=dict(), + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + visualization_object=dict( + data=JsonApiVisualizationObjectToOneLinkage(None), + ), + ), + type="exportDefinition", + ), + ) + try: + # Put an Export Definition + api_response = api_instance.update_entity_export_definitions( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportDefinitionsApi->update_entity_export_definitions: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionInDocument**](../../models/JsonApiExportDefinitionInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionInDocument**](../../models/JsonApiExportDefinitionInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["visualizationObjects", "analyticalDashboards", "automations", "userIdentifiers", "visualizationObject", "analyticalDashboard", "automation", "createdBy", "modifiedBy", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#update_entity_export_definitions.ApiResponseFor200) | Request successfully processed + +#### update_entity_export_definitions.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionOutDocument**](../../models/JsonApiExportDefinitionOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportDefinitionOutDocument**](../../models/JsonApiExportDefinitionOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/ExportTemplatesApi.md b/gooddata-api-client/docs/apis/tags/ExportTemplatesApi.md new file mode 100644 index 000000000..3182727c1 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/ExportTemplatesApi.md @@ -0,0 +1,1000 @@ + +# gooddata_api_client.apis.tags.export_templates_api.ExportTemplatesApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_export_templates**](#create_entity_export_templates) | **post** /api/v1/entities/exportTemplates | Post Export Template entities +[**delete_entity_export_templates**](#delete_entity_export_templates) | **delete** /api/v1/entities/exportTemplates/{id} | Delete Export Template entity +[**get_all_entities_export_templates**](#get_all_entities_export_templates) | **get** /api/v1/entities/exportTemplates | GET all Export Template entities +[**get_entity_export_templates**](#get_entity_export_templates) | **get** /api/v1/entities/exportTemplates/{id} | GET Export Template entity +[**patch_entity_export_templates**](#patch_entity_export_templates) | **patch** /api/v1/entities/exportTemplates/{id} | Patch Export Template entity +[**update_entity_export_templates**](#update_entity_export_templates) | **put** /api/v1/entities/exportTemplates/{id} | PUT Export Template entity + +# **create_entity_export_templates** + +> JsonApiExportTemplateOutDocument create_entity_export_templates(json_api_export_template_post_optional_id_document) + +Post Export Template entities + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import export_templates_api +from gooddata_api_client.model.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = export_templates_api.ExportTemplatesApi(api_client) + + # example passing only required values which don't have defaults set + body = JsonApiExportTemplatePostOptionalIdDocument( + data=JsonApiExportTemplatePostOptionalId( + attributes=dict( + dashboard_slides_template=dict( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), +, + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection(), + header=RunningSection(), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field="About:\n{{dashboardDescription}}\n\n{{dashboardFilters}}", + footer=RunningSection(), + header=RunningSection(), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection(), + header=RunningSection(), + ), + ), + name="name_example", + widget_slides_template=dict( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate(), + ), + ), + id="id1", + type="exportTemplate", + ), + ) + try: + # Post Export Template entities + api_response = api_instance.create_entity_export_templates( + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->create_entity_export_templates: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportTemplatePostOptionalIdDocument**](../../models/JsonApiExportTemplatePostOptionalIdDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportTemplatePostOptionalIdDocument**](../../models/JsonApiExportTemplatePostOptionalIdDocument.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_entity_export_templates.ApiResponseFor201) | Request successfully processed + +#### create_entity_export_templates.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, SchemaFor201ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportTemplateOutDocument**](../../models/JsonApiExportTemplateOutDocument.md) | | + + +# SchemaFor201ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportTemplateOutDocument**](../../models/JsonApiExportTemplateOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 Export Template entity + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import export_templates_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = export_templates_api.ExportTemplatesApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + try: + # Delete Export Template entity + api_response = api_instance.delete_entity_export_templates( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->delete_entity_export_templates: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + } + try: + # Delete Export Template entity + api_response = api_instance.delete_entity_export_templates( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->delete_entity_export_templates: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_entity_export_templates.ApiResponseFor204) | Successfully deleted + +#### delete_entity_export_templates.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_all_entities_export_templates** + +> JsonApiExportTemplateOutList get_all_entities_export_templates() + +GET all Export Template entities + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import export_templates_api +from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = export_templates_api.ExportTemplatesApi(api_client) + + # example passing only optional values + query_params = { + 'filter': "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=page,all" + ], + } + try: + # GET all Export Template entities + api_response = api_instance.get_all_entities_export_templates( + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->get_all_entities_export_templates: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["page", "all", "ALL", ] + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_entities_export_templates.ApiResponseFor200) | Request successfully processed + +#### get_all_entities_export_templates.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportTemplateOutList**](../../models/JsonApiExportTemplateOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportTemplateOutList**](../../models/JsonApiExportTemplateOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_entity_export_templates** + +> JsonApiExportTemplateOutDocument get_entity_export_templates(id) + +GET Export Template entity + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import export_templates_api +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = export_templates_api.ExportTemplatesApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + try: + # GET Export Template entity + api_response = api_instance.get_entity_export_templates( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->get_entity_export_templates: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + } + try: + # GET Export Template entity + api_response = api_instance.get_entity_export_templates( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->get_entity_export_templates: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_entity_export_templates.ApiResponseFor200) | Request successfully processed + +#### get_entity_export_templates.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportTemplateOutDocument**](../../models/JsonApiExportTemplateOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportTemplateOutDocument**](../../models/JsonApiExportTemplateOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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(idjson_api_export_template_patch_document) + +Patch Export Template entity + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import export_templates_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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = export_templates_api.ExportTemplatesApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + body = JsonApiExportTemplatePatchDocument( + data=JsonApiExportTemplatePatch( + attributes=dict( + dashboard_slides_template=dict( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), +, + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection(), + header=RunningSection(), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field="About:\n{{dashboardDescription}}\n\n{{dashboardFilters}}", + footer=RunningSection(), + header=RunningSection(), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection(), + header=RunningSection(), + ), + ), + name="name_example", + widget_slides_template=dict( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate(), + ), + ), + id="id1", + type="exportTemplate", + ), + ) + try: + # Patch Export Template entity + api_response = api_instance.patch_entity_export_templates( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->patch_entity_export_templates: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + } + body = JsonApiExportTemplatePatchDocument( + data=JsonApiExportTemplatePatch( + attributes=dict( + dashboard_slides_template=dict( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), +, + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection(), + header=RunningSection(), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field="About:\n{{dashboardDescription}}\n\n{{dashboardFilters}}", + footer=RunningSection(), + header=RunningSection(), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection(), + header=RunningSection(), + ), + ), + name="name_example", + widget_slides_template=dict( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate(), + ), + ), + id="id1", + type="exportTemplate", + ), + ) + try: + # Patch Export Template entity + api_response = api_instance.patch_entity_export_templates( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->patch_entity_export_templates: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportTemplatePatchDocument**](../../models/JsonApiExportTemplatePatchDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportTemplatePatchDocument**](../../models/JsonApiExportTemplatePatchDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#patch_entity_export_templates.ApiResponseFor200) | Request successfully processed + +#### patch_entity_export_templates.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportTemplateOutDocument**](../../models/JsonApiExportTemplateOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportTemplateOutDocument**](../../models/JsonApiExportTemplateOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **update_entity_export_templates** + +> JsonApiExportTemplateOutDocument update_entity_export_templates(idjson_api_export_template_in_document) + +PUT Export Template entity + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import export_templates_api +from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = export_templates_api.ExportTemplatesApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + body = JsonApiExportTemplateInDocument( + data=JsonApiExportTemplateIn( + attributes=dict( + dashboard_slides_template=dict( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), +, + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection(), + header=RunningSection(), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field="About:\n{{dashboardDescription}}\n\n{{dashboardFilters}}", + footer=RunningSection(), + header=RunningSection(), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection(), + header=RunningSection(), + ), + ), + name="name_example", + widget_slides_template=dict( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate(), + ), + ), + id="id1", + type="exportTemplate", + ), + ) + try: + # PUT Export Template entity + api_response = api_instance.update_entity_export_templates( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->update_entity_export_templates: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + } + body = JsonApiExportTemplateInDocument( + data=JsonApiExportTemplateIn( + attributes=dict( + dashboard_slides_template=dict( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), +, + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection(), + header=RunningSection(), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field="About:\n{{dashboardDescription}}\n\n{{dashboardFilters}}", + footer=RunningSection(), + header=RunningSection(), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection(), + header=RunningSection(), + ), + ), + name="name_example", + widget_slides_template=dict( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate(), + ), + ), + id="id1", + type="exportTemplate", + ), + ) + try: + # PUT Export Template entity + api_response = api_instance.update_entity_export_templates( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->update_entity_export_templates: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportTemplateInDocument**](../../models/JsonApiExportTemplateInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportTemplateInDocument**](../../models/JsonApiExportTemplateInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#update_entity_export_templates.ApiResponseFor200) | Request successfully processed + +#### update_entity_export_templates.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportTemplateOutDocument**](../../models/JsonApiExportTemplateOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiExportTemplateOutDocument**](../../models/JsonApiExportTemplateOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/FilterContextApi.md b/gooddata-api-client/docs/apis/tags/FilterContextApi.md new file mode 100644 index 000000000..79869db63 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/FilterContextApi.md @@ -0,0 +1,1378 @@ + +# gooddata_api_client.apis.tags.filter_context_api.FilterContextApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_filter_contexts**](#create_entity_filter_contexts) | **post** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Post Filter Context +[**delete_entity_filter_contexts**](#delete_entity_filter_contexts) | **delete** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Delete a Filter Context +[**get_all_entities_filter_contexts**](#get_all_entities_filter_contexts) | **get** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Get all Filter Context +[**get_entity_filter_contexts**](#get_entity_filter_contexts) | **get** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Get a Filter Context +[**patch_entity_filter_contexts**](#patch_entity_filter_contexts) | **patch** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Patch a Filter Context +[**search_entities_filter_contexts**](#search_entities_filter_contexts) | **post** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | Search request for FilterContext +[**update_entity_filter_contexts**](#update_entity_filter_contexts) | **put** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Put a Filter Context + +# **create_entity_filter_contexts** + +> JsonApiFilterContextOutDocument create_entity_filter_contexts(workspace_idjson_api_filter_context_post_optional_id_document) + +Post Filter Context + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import filter_context_api +from gooddata_api_client.model.json_api_filter_context_post_optional_id_document import JsonApiFilterContextPostOptionalIdDocument +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = filter_context_api.FilterContextApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + body = JsonApiFilterContextPostOptionalIdDocument( + data=JsonApiFilterContextPostOptionalId( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + type="filterContext", + ), + ) + try: + # Post Filter Context + api_response = api_instance.create_entity_filter_contexts( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextApi->create_entity_filter_contexts: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'include': [ + "attributes,datasets,labels" + ], + 'metaInclude': [ + "metaInclude=origin,all" + ], + } + body = JsonApiFilterContextPostOptionalIdDocument( + data=JsonApiFilterContextPostOptionalId( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + type="filterContext", + ), + ) + try: + # Post Filter Context + api_response = api_instance.create_entity_filter_contexts( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextApi->create_entity_filter_contexts: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextPostOptionalIdDocument**](../../models/JsonApiFilterContextPostOptionalIdDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextPostOptionalIdDocument**](../../models/JsonApiFilterContextPostOptionalIdDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +include | IncludeSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["attributes", "datasets", "labels", "ALL", ] + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "all", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_entity_filter_contexts.ApiResponseFor201) | Request successfully processed + +#### create_entity_filter_contexts.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, SchemaFor201ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextOutDocument**](../../models/JsonApiFilterContextOutDocument.md) | | + + +# SchemaFor201ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextOutDocument**](../../models/JsonApiFilterContextOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_id) + +Delete a Filter Context + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import filter_context_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(configuration) as api_client: + # Create an instance of the API class + api_instance = filter_context_api.FilterContextApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + try: + # Delete a Filter Context + api_response = api_instance.delete_entity_filter_contexts( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextApi->delete_entity_filter_contexts: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString", + } + try: + # Delete a Filter Context + api_response = api_instance.delete_entity_filter_contexts( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextApi->delete_entity_filter_contexts: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_entity_filter_contexts.ApiResponseFor204) | Successfully deleted + +#### delete_entity_filter_contexts.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 Filter Context + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import filter_context_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = filter_context_api.FilterContextApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + header_params = { + } + try: + # Get all Filter Context + api_response = api_instance.get_all_entities_filter_contexts( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextApi->get_all_entities_filter_contexts: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'origin': "ALL", + 'filter': "title==someString;description==someString", + 'include': [ + "attributes,datasets,labels" + ], + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=origin,page,all" + ], + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + try: + # Get all Filter Context + api_response = api_instance.get_all_entities_filter_contexts( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextApi->get_all_entities_filter_contexts: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +origin | OriginSchema | | optional +filter | FilterSchema | | optional +include | IncludeSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# OriginSchema + +Defines scope of origin of objects. All by default. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Defines scope of origin of objects. All by default. | must be one of ["ALL", "PARENTS", "NATIVE", ] if omitted the server will use the default value of "ALL" + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["attributes", "datasets", "labels", "ALL", ] + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "page", "all", "ALL", ] + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_entities_filter_contexts.ApiResponseFor200) | Request successfully processed + +#### get_all_entities_filter_contexts.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextOutList**](../../models/JsonApiFilterContextOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextOutList**](../../models/JsonApiFilterContextOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_id) + +Get a Filter Context + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import filter_context_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = filter_context_api.FilterContextApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + header_params = { + } + try: + # Get a Filter Context + api_response = api_instance.get_entity_filter_contexts( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextApi->get_entity_filter_contexts: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString", + 'include': [ + "attributes,datasets,labels" + ], + 'metaInclude': [ + "metaInclude=origin,all" + ], + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + try: + # Get a Filter Context + api_response = api_instance.get_entity_filter_contexts( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextApi->get_entity_filter_contexts: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["attributes", "datasets", "labels", "ALL", ] + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["origin", "all", "ALL", ] + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_entity_filter_contexts.ApiResponseFor200) | Request successfully processed + +#### get_entity_filter_contexts.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextOutDocument**](../../models/JsonApiFilterContextOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextOutDocument**](../../models/JsonApiFilterContextOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_idjson_api_filter_context_patch_document) + +Patch a Filter Context + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import filter_context_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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = filter_context_api.FilterContextApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + body = JsonApiFilterContextPatchDocument( + data=JsonApiFilterContextPatch( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + type="filterContext", + ), + ) + try: + # Patch a Filter Context + api_response = api_instance.patch_entity_filter_contexts( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextApi->patch_entity_filter_contexts: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString", + 'include': [ + "attributes,datasets,labels" + ], + } + body = JsonApiFilterContextPatchDocument( + data=JsonApiFilterContextPatch( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + type="filterContext", + ), + ) + try: + # Patch a Filter Context + api_response = api_instance.patch_entity_filter_contexts( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextApi->patch_entity_filter_contexts: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextPatchDocument**](../../models/JsonApiFilterContextPatchDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextPatchDocument**](../../models/JsonApiFilterContextPatchDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["attributes", "datasets", "labels", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#patch_entity_filter_contexts.ApiResponseFor200) | Request successfully processed + +#### patch_entity_filter_contexts.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextOutDocument**](../../models/JsonApiFilterContextOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextOutDocument**](../../models/JsonApiFilterContextOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_filter_contexts** + +> JsonApiFilterContextOutList search_entities_filter_contexts(workspace_identity_search_body) + +Search request for FilterContext + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import filter_context_api +from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList +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(configuration) as api_client: + # Create an instance of the API class + api_instance = filter_context_api.FilterContextApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + header_params = { + } + 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", + ) + ], + ) + try: + # Search request for FilterContext + api_response = api_instance.search_entities_filter_contexts( + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextApi->search_entities_filter_contexts: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'origin': "ALL", + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + 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", + ) + ], + ) + try: + # Search request for FilterContext + api_response = api_instance.search_entities_filter_contexts( + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextApi->search_entities_filter_contexts: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**EntitySearchBody**](../../models/EntitySearchBody.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +origin | OriginSchema | | optional + + +# OriginSchema + +Defines scope of origin of objects. All by default. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Defines scope of origin of objects. All by default. | must be one of ["ALL", "PARENTS", "NATIVE", ] if omitted the server will use the default value of "ALL" + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#search_entities_filter_contexts.ApiResponseFor200) | Request successfully processed + +#### search_entities_filter_contexts.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextOutList**](../../models/JsonApiFilterContextOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextOutList**](../../models/JsonApiFilterContextOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **update_entity_filter_contexts** + +> JsonApiFilterContextOutDocument update_entity_filter_contexts(workspace_idobject_idjson_api_filter_context_in_document) + +Put a Filter Context + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import filter_context_api +from gooddata_api_client.model.json_api_filter_context_in_document import JsonApiFilterContextInDocument +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = filter_context_api.FilterContextApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + body = JsonApiFilterContextInDocument( + data=JsonApiFilterContextIn( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + type="filterContext", + ), + ) + try: + # Put a Filter Context + api_response = api_instance.update_entity_filter_contexts( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextApi->update_entity_filter_contexts: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString", + 'include': [ + "attributes,datasets,labels" + ], + } + body = JsonApiFilterContextInDocument( + data=JsonApiFilterContextIn( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + type="filterContext", + ), + ) + try: + # Put a Filter Context + api_response = api_instance.update_entity_filter_contexts( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterContextApi->update_entity_filter_contexts: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextInDocument**](../../models/JsonApiFilterContextInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextInDocument**](../../models/JsonApiFilterContextInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["attributes", "datasets", "labels", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#update_entity_filter_contexts.ApiResponseFor200) | Request successfully processed + +#### update_entity_filter_contexts.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextOutDocument**](../../models/JsonApiFilterContextOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterContextOutDocument**](../../models/JsonApiFilterContextOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/FilterViewsApi.md b/gooddata-api-client/docs/apis/tags/FilterViewsApi.md new file mode 100644 index 000000000..e9ac09eb9 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/FilterViewsApi.md @@ -0,0 +1,1654 @@ + +# gooddata_api_client.apis.tags.filter_views_api.FilterViewsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_filter_views**](#create_entity_filter_views) | **post** /api/v1/entities/workspaces/{workspaceId}/filterViews | Post Filter views +[**delete_entity_filter_views**](#delete_entity_filter_views) | **delete** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Delete Filter view +[**get_all_entities_filter_views**](#get_all_entities_filter_views) | **get** /api/v1/entities/workspaces/{workspaceId}/filterViews | Get all Filter views +[**get_entity_filter_views**](#get_entity_filter_views) | **get** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Get Filter view +[**get_filter_views**](#get_filter_views) | **get** /api/v1/layout/workspaces/{workspaceId}/filterViews | Get filter views +[**patch_entity_filter_views**](#patch_entity_filter_views) | **patch** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Patch Filter view +[**search_entities_filter_views**](#search_entities_filter_views) | **post** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | Search request for FilterView +[**set_filter_views**](#set_filter_views) | **put** /api/v1/layout/workspaces/{workspaceId}/filterViews | Set filter views +[**update_entity_filter_views**](#update_entity_filter_views) | **put** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Put Filter views + +# **create_entity_filter_views** + +> JsonApiFilterViewOutDocument create_entity_filter_views(workspace_idjson_api_filter_view_in_document) + +Post Filter views + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import filter_views_api +from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = filter_views_api.FilterViewsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + body = JsonApiFilterViewInDocument( + data=JsonApiFilterViewIn( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + is_default=True, + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + user=dict( + data=JsonApiUserToOneLinkage(None), + ), + ), + type="filterView", + ), + ) + try: + # Post Filter views + api_response = api_instance.create_entity_filter_views( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->create_entity_filter_views: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'include': [ + "analyticalDashboard,user" + ], + } + body = JsonApiFilterViewInDocument( + data=JsonApiFilterViewIn( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + is_default=True, + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + user=dict( + data=JsonApiUserToOneLinkage(None), + ), + ), + type="filterView", + ), + ) + try: + # Post Filter views + api_response = api_instance.create_entity_filter_views( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->create_entity_filter_views: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewInDocument**](../../models/JsonApiFilterViewInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewInDocument**](../../models/JsonApiFilterViewInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +include | IncludeSchema | | optional + + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["analyticalDashboards", "users", "analyticalDashboard", "user", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_entity_filter_views.ApiResponseFor201) | Request successfully processed + +#### create_entity_filter_views.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, SchemaFor201ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewOutDocument**](../../models/JsonApiFilterViewOutDocument.md) | | + + +# SchemaFor201ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewOutDocument**](../../models/JsonApiFilterViewOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_id) + +Delete Filter view + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import filter_views_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(configuration) as api_client: + # Create an instance of the API class + api_instance = filter_views_api.FilterViewsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + try: + # Delete Filter view + api_response = api_instance.delete_entity_filter_views( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->delete_entity_filter_views: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + } + try: + # Delete Filter view + api_response = api_instance.delete_entity_filter_views( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->delete_entity_filter_views: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_entity_filter_views.ApiResponseFor204) | Successfully deleted + +#### delete_entity_filter_views.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 Filter views + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import filter_views_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = filter_views_api.FilterViewsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + header_params = { + } + try: + # Get all Filter views + api_response = api_instance.get_all_entities_filter_views( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->get_all_entities_filter_views: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'origin': "ALL", + 'filter': "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + 'include': [ + "analyticalDashboard,user" + ], + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=page,all" + ], + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + try: + # Get all Filter views + api_response = api_instance.get_all_entities_filter_views( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->get_all_entities_filter_views: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +origin | OriginSchema | | optional +filter | FilterSchema | | optional +include | IncludeSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# OriginSchema + +Defines scope of origin of objects. All by default. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Defines scope of origin of objects. All by default. | must be one of ["ALL", "PARENTS", "NATIVE", ] if omitted the server will use the default value of "ALL" + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["analyticalDashboards", "users", "analyticalDashboard", "user", "ALL", ] + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["page", "all", "ALL", ] + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_entities_filter_views.ApiResponseFor200) | Request successfully processed + +#### get_all_entities_filter_views.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewOutList**](../../models/JsonApiFilterViewOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewOutList**](../../models/JsonApiFilterViewOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_id) + +Get Filter view + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import filter_views_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = filter_views_api.FilterViewsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + header_params = { + } + try: + # Get Filter view + api_response = api_instance.get_entity_filter_views( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->get_entity_filter_views: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + 'include': [ + "analyticalDashboard,user" + ], + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + try: + # Get Filter view + api_response = api_instance.get_entity_filter_views( + path_params=path_params, + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->get_entity_filter_views: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["analyticalDashboards", "users", "analyticalDashboard", "user", "ALL", ] + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_entity_filter_views.ApiResponseFor200) | Request successfully processed + +#### get_entity_filter_views.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewOutDocument**](../../models/JsonApiFilterViewOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewOutDocument**](../../models/JsonApiFilterViewOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_filter_views** + +> [DeclarativeFilterView] get_filter_views(workspace_id) + +Get filter views + +Retrieve filter views for the specific workspace + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import filter_views_api +from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = filter_views_api.FilterViewsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + try: + # Get filter views + api_response = api_instance.get_filter_views( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->get_filter_views: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'exclude': [ + "ACTIVITY_INFO" + ], + } + try: + # Get filter views + api_response = api_instance.get_filter_views( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->get_filter_views: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +exclude | ExcludeSchema | | optional + + +# ExcludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Defines properties which should not be included in the payload. | must be one of ["ACTIVITY_INFO", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_filter_views.ApiResponseFor200) | Retrieved filterViews. + +#### get_filter_views.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DeclarativeFilterView**]({{complexTypePrefix}}DeclarativeFilterView.md) | [**DeclarativeFilterView**]({{complexTypePrefix}}DeclarativeFilterView.md) | [**DeclarativeFilterView**]({{complexTypePrefix}}DeclarativeFilterView.md) | | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idobject_idjson_api_filter_view_patch_document) + +Patch Filter view + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import filter_views_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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = filter_views_api.FilterViewsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + body = JsonApiFilterViewPatchDocument( + data=JsonApiFilterViewPatch( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + is_default=True, + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + user=dict( + data=JsonApiUserToOneLinkage(None), + ), + ), + type="filterView", + ), + ) + try: + # Patch Filter view + api_response = api_instance.patch_entity_filter_views( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->patch_entity_filter_views: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + 'include': [ + "analyticalDashboard,user" + ], + } + body = JsonApiFilterViewPatchDocument( + data=JsonApiFilterViewPatch( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + is_default=True, + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + user=dict( + data=JsonApiUserToOneLinkage(None), + ), + ), + type="filterView", + ), + ) + try: + # Patch Filter view + api_response = api_instance.patch_entity_filter_views( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->patch_entity_filter_views: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewPatchDocument**](../../models/JsonApiFilterViewPatchDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewPatchDocument**](../../models/JsonApiFilterViewPatchDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["analyticalDashboards", "users", "analyticalDashboard", "user", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#patch_entity_filter_views.ApiResponseFor200) | Request successfully processed + +#### patch_entity_filter_views.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewOutDocument**](../../models/JsonApiFilterViewOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewOutDocument**](../../models/JsonApiFilterViewOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_filter_views** + +> JsonApiFilterViewOutList search_entities_filter_views(workspace_identity_search_body) + +Search request for FilterView + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import filter_views_api +from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList +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(configuration) as api_client: + # Create an instance of the API class + api_instance = filter_views_api.FilterViewsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + header_params = { + } + 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", + ) + ], + ) + try: + # Search request for FilterView + api_response = api_instance.search_entities_filter_views( + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->search_entities_filter_views: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'origin': "ALL", + } + header_params = { + 'X-GDC-VALIDATE-RELATIONS': False, + } + 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", + ) + ], + ) + try: + # Search request for FilterView + api_response = api_instance.search_entities_filter_views( + path_params=path_params, + query_params=query_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->search_entities_filter_views: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +query_params | RequestQueryParams | | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**EntitySearchBody**](../../models/EntitySearchBody.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +origin | OriginSchema | | optional + + +# OriginSchema + +Defines scope of origin of objects. All by default. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | Defines scope of origin of objects. All by default. | must be one of ["ALL", "PARENTS", "NATIVE", ] if omitted the server will use the default value of "ALL" + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-GDC-VALIDATE-RELATIONS | XGDCVALIDATERELATIONSSchema | | optional + +# XGDCVALIDATERELATIONSSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#search_entities_filter_views.ApiResponseFor200) | Request successfully processed + +#### search_entities_filter_views.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewOutList**](../../models/JsonApiFilterViewOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewOutList**](../../models/JsonApiFilterViewOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **set_filter_views** + +> set_filter_views(workspace_iddeclarative_filter_view) + +Set filter views + +Set filter views for the specific workspace. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import filter_views_api +from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = filter_views_api.FilterViewsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = [ + DeclarativeFilterView( + analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( + id="dashboard123", + type="analyticalDashboard", + ), + content=JsonNode(), + description="description_example", + id="filterView-1", + is_default=True, + tags=[ + "[\"Revenue\",\"Sales\"]" + ], + title="title_example", + user=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + ) + ] + try: + # Set filter views + api_response = api_instance.set_filter_views( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->set_filter_views: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DeclarativeFilterView**]({{complexTypePrefix}}DeclarativeFilterView.md) | [**DeclarativeFilterView**]({{complexTypePrefix}}DeclarativeFilterView.md) | [**DeclarativeFilterView**]({{complexTypePrefix}}DeclarativeFilterView.md) | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#set_filter_views.ApiResponseFor204) | FilterViews successfully set. + +#### set_filter_views.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **update_entity_filter_views** + +> JsonApiFilterViewOutDocument update_entity_filter_views(workspace_idobject_idjson_api_filter_view_in_document) + +Put Filter views + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import filter_views_api +from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = filter_views_api.FilterViewsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + } + body = JsonApiFilterViewInDocument( + data=JsonApiFilterViewIn( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + is_default=True, + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + user=dict( + data=JsonApiUserToOneLinkage(None), + ), + ), + type="filterView", + ), + ) + try: + # Put Filter views + api_response = api_instance.update_entity_filter_views( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->update_entity_filter_views: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + 'objectId': "objectId_example", + } + query_params = { + 'filter': "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + 'include': [ + "analyticalDashboard,user" + ], + } + body = JsonApiFilterViewInDocument( + data=JsonApiFilterViewIn( + attributes=dict( + are_relations_valid=True, + content=dict(), + description="description_example", + is_default=True, + tags=[ + "tags_example" + ], + title="title_example", + ), + id="id1", + relationships=dict( + analytical_dashboard=dict( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + user=dict( + data=JsonApiUserToOneLinkage(None), + ), + ), + type="filterView", + ), + ) + try: + # Put Filter views + api_response = api_instance.update_entity_filter_views( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->update_entity_filter_views: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewInDocument**](../../models/JsonApiFilterViewInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewInDocument**](../../models/JsonApiFilterViewInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +include | IncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["analyticalDashboards", "users", "analyticalDashboard", "user", "ALL", ] + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +objectId | ObjectIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ObjectIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#update_entity_filter_views.ApiResponseFor200) | Request successfully processed + +#### update_entity_filter_views.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewOutDocument**](../../models/JsonApiFilterViewOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiFilterViewOutDocument**](../../models/JsonApiFilterViewOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/GeographicDataApi.md b/gooddata-api-client/docs/apis/tags/GeographicDataApi.md new file mode 100644 index 000000000..a0b79640d --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/GeographicDataApi.md @@ -0,0 +1,830 @@ + +# gooddata_api_client.apis.tags.geographic_data_api.GeographicDataApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_custom_geo_collections**](#create_entity_custom_geo_collections) | **post** /api/v1/entities/customGeoCollections | +[**delete_entity_custom_geo_collections**](#delete_entity_custom_geo_collections) | **delete** /api/v1/entities/customGeoCollections/{id} | +[**get_all_entities_custom_geo_collections**](#get_all_entities_custom_geo_collections) | **get** /api/v1/entities/customGeoCollections | +[**get_entity_custom_geo_collections**](#get_entity_custom_geo_collections) | **get** /api/v1/entities/customGeoCollections/{id} | +[**patch_entity_custom_geo_collections**](#patch_entity_custom_geo_collections) | **patch** /api/v1/entities/customGeoCollections/{id} | +[**update_entity_custom_geo_collections**](#update_entity_custom_geo_collections) | **put** /api/v1/entities/customGeoCollections/{id} | + +# **create_entity_custom_geo_collections** + +> JsonApiCustomGeoCollectionOutDocument create_entity_custom_geo_collections(json_api_custom_geo_collection_in_document) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import geographic_data_api +from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument +from gooddata_api_client.model.json_api_custom_geo_collection_in_document import JsonApiCustomGeoCollectionInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = geographic_data_api.GeographicDataApi(api_client) + + # example passing only required values which don't have defaults set + body = JsonApiCustomGeoCollectionInDocument( + data=JsonApiCustomGeoCollectionIn( + attributes=dict( + description="description_example", + name="name_example", + ), + id="id1", + type="customGeoCollection", + ), + ) + try: + api_response = api_instance.create_entity_custom_geo_collections( + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling GeographicDataApi->create_entity_custom_geo_collections: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionInDocument**](../../models/JsonApiCustomGeoCollectionInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionInDocument**](../../models/JsonApiCustomGeoCollectionInDocument.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_entity_custom_geo_collections.ApiResponseFor201) | Request successfully processed + +#### create_entity_custom_geo_collections.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, SchemaFor201ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionOutDocument**](../../models/JsonApiCustomGeoCollectionOutDocument.md) | | + + +# SchemaFor201ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionOutDocument**](../../models/JsonApiCustomGeoCollectionOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import geographic_data_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(configuration) as api_client: + # Create an instance of the API class + api_instance = geographic_data_api.GeographicDataApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + try: + api_response = api_instance.delete_entity_custom_geo_collections( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling GeographicDataApi->delete_entity_custom_geo_collections: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;description==someString", + } + try: + api_response = api_instance.delete_entity_custom_geo_collections( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling GeographicDataApi->delete_entity_custom_geo_collections: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_entity_custom_geo_collections.ApiResponseFor204) | Successfully deleted + +#### delete_entity_custom_geo_collections.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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() + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import geographic_data_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = geographic_data_api.GeographicDataApi(api_client) + + # example passing only optional values + query_params = { + 'filter': "name==someString;description==someString", + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=page,all" + ], + } + try: + api_response = api_instance.get_all_entities_custom_geo_collections( + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling GeographicDataApi->get_all_entities_custom_geo_collections: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["page", "all", "ALL", ] + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_entities_custom_geo_collections.ApiResponseFor200) | Request successfully processed + +#### get_all_entities_custom_geo_collections.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionOutList**](../../models/JsonApiCustomGeoCollectionOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionOutList**](../../models/JsonApiCustomGeoCollectionOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import geographic_data_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = geographic_data_api.GeographicDataApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + try: + api_response = api_instance.get_entity_custom_geo_collections( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling GeographicDataApi->get_entity_custom_geo_collections: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;description==someString", + } + try: + api_response = api_instance.get_entity_custom_geo_collections( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling GeographicDataApi->get_entity_custom_geo_collections: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_entity_custom_geo_collections.ApiResponseFor200) | Request successfully processed + +#### get_entity_custom_geo_collections.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionOutDocument**](../../models/JsonApiCustomGeoCollectionOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionOutDocument**](../../models/JsonApiCustomGeoCollectionOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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(idjson_api_custom_geo_collection_patch_document) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import geographic_data_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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = geographic_data_api.GeographicDataApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + body = JsonApiCustomGeoCollectionPatchDocument( + data=JsonApiCustomGeoCollectionPatch( + attributes=dict( + description="description_example", + name="name_example", + ), + id="id1", + type="customGeoCollection", + ), + ) + try: + api_response = api_instance.patch_entity_custom_geo_collections( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling GeographicDataApi->patch_entity_custom_geo_collections: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;description==someString", + } + body = JsonApiCustomGeoCollectionPatchDocument( + data=JsonApiCustomGeoCollectionPatch( + attributes=dict( + description="description_example", + name="name_example", + ), + id="id1", + type="customGeoCollection", + ), + ) + try: + api_response = api_instance.patch_entity_custom_geo_collections( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling GeographicDataApi->patch_entity_custom_geo_collections: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionPatchDocument**](../../models/JsonApiCustomGeoCollectionPatchDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionPatchDocument**](../../models/JsonApiCustomGeoCollectionPatchDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#patch_entity_custom_geo_collections.ApiResponseFor200) | Request successfully processed + +#### patch_entity_custom_geo_collections.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionOutDocument**](../../models/JsonApiCustomGeoCollectionOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionOutDocument**](../../models/JsonApiCustomGeoCollectionOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_custom_geo_collections** + +> JsonApiCustomGeoCollectionOutDocument update_entity_custom_geo_collections(idjson_api_custom_geo_collection_in_document) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import geographic_data_api +from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument +from gooddata_api_client.model.json_api_custom_geo_collection_in_document import JsonApiCustomGeoCollectionInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = geographic_data_api.GeographicDataApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + body = JsonApiCustomGeoCollectionInDocument( + data=JsonApiCustomGeoCollectionIn( + attributes=dict( + description="description_example", + name="name_example", + ), + id="id1", + type="customGeoCollection", + ), + ) + try: + api_response = api_instance.update_entity_custom_geo_collections( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling GeographicDataApi->update_entity_custom_geo_collections: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;description==someString", + } + body = JsonApiCustomGeoCollectionInDocument( + data=JsonApiCustomGeoCollectionIn( + attributes=dict( + description="description_example", + name="name_example", + ), + id="id1", + type="customGeoCollection", + ), + ) + try: + api_response = api_instance.update_entity_custom_geo_collections( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling GeographicDataApi->update_entity_custom_geo_collections: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionInDocument**](../../models/JsonApiCustomGeoCollectionInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionInDocument**](../../models/JsonApiCustomGeoCollectionInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#update_entity_custom_geo_collections.ApiResponseFor200) | Request successfully processed + +#### update_entity_custom_geo_collections.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionOutDocument**](../../models/JsonApiCustomGeoCollectionOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionOutDocument**](../../models/JsonApiCustomGeoCollectionOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/HierarchyApi.md b/gooddata-api-client/docs/apis/tags/HierarchyApi.md new file mode 100644 index 000000000..e404b3292 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/HierarchyApi.md @@ -0,0 +1,417 @@ + +# gooddata_api_client.apis.tags.hierarchy_api.HierarchyApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**check_entity_overrides**](#check_entity_overrides) | **post** /api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides | Finds entities with given ID in hierarchy. +[**inherited_entity_conflicts**](#inherited_entity_conflicts) | **get** /api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts | Finds identifier conflicts in workspace hierarchy. +[**inherited_entity_prefixes**](#inherited_entity_prefixes) | **get** /api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes | Get used entity prefixes in hierarchy +[**overridden_child_entities**](#overridden_child_entities) | **get** /api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities | Finds identifier overrides in workspace hierarchy. + +# **check_entity_overrides** + +> [IdentifierDuplications] check_entity_overrides(workspace_idhierarchy_object_identification) + +Finds entities with given ID in hierarchy. + +Finds entities with given ID in hierarchy (e.g. to check possible future conflicts). + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import hierarchy_api +from gooddata_api_client.model.hierarchy_object_identification import HierarchyObjectIdentification +from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = hierarchy_api.HierarchyApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = [ + HierarchyObjectIdentification( + id="id_example", + type="metric", + ) + ] + try: + # Finds entities with given ID in hierarchy. + api_response = api_instance.check_entity_overrides( + path_params=path_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling HierarchyApi->check_entity_overrides: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson + +An array of object identifications + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | An array of object identifications | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**HierarchyObjectIdentification**]({{complexTypePrefix}}HierarchyObjectIdentification.md) | [**HierarchyObjectIdentification**]({{complexTypePrefix}}HierarchyObjectIdentification.md) | [**HierarchyObjectIdentification**]({{complexTypePrefix}}HierarchyObjectIdentification.md) | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#check_entity_overrides.ApiResponseFor200) | Searching for entities finished successfully. + +#### check_entity_overrides.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**IdentifierDuplications**]({{complexTypePrefix}}IdentifierDuplications.md) | [**IdentifierDuplications**]({{complexTypePrefix}}IdentifierDuplications.md) | [**IdentifierDuplications**]({{complexTypePrefix}}IdentifierDuplications.md) | | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **inherited_entity_conflicts** + +> [IdentifierDuplications] inherited_entity_conflicts(workspace_id) + +Finds identifier conflicts in workspace hierarchy. + +Finds API identifier conflicts in given workspace hierarchy. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import hierarchy_api +from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = hierarchy_api.HierarchyApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + try: + # Finds identifier conflicts in workspace hierarchy. + api_response = api_instance.inherited_entity_conflicts( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling HierarchyApi->inherited_entity_conflicts: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#inherited_entity_conflicts.ApiResponseFor200) | Searching for conflicting identifiers finished successfully + +#### inherited_entity_conflicts.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**IdentifierDuplications**]({{complexTypePrefix}}IdentifierDuplications.md) | [**IdentifierDuplications**]({{complexTypePrefix}}IdentifierDuplications.md) | [**IdentifierDuplications**]({{complexTypePrefix}}IdentifierDuplications.md) | | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **inherited_entity_prefixes** + +> [str] inherited_entity_prefixes(workspace_id) + +Get used entity prefixes in hierarchy + +Get used entity prefixes in hierarchy of parent workspaces + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import hierarchy_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(configuration) as api_client: + # Create an instance of the API class + api_instance = hierarchy_api.HierarchyApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + try: + # Get used entity prefixes in hierarchy + api_response = api_instance.inherited_entity_prefixes( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling HierarchyApi->inherited_entity_prefixes: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#inherited_entity_prefixes.ApiResponseFor200) | Prefixes used in parent entities + +#### inherited_entity_prefixes.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **overridden_child_entities** + +> [IdentifierDuplications] overridden_child_entities(workspace_id) + +Finds identifier overrides in workspace hierarchy. + +Finds API identifier overrides in given workspace hierarchy. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import hierarchy_api +from gooddata_api_client.model.identifier_duplications import IdentifierDuplications +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = hierarchy_api.HierarchyApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + try: + # Finds identifier overrides in workspace hierarchy. + api_response = api_instance.overridden_child_entities( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling HierarchyApi->overridden_child_entities: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#overridden_child_entities.ApiResponseFor200) | Searching for overridden identifiers finished successfully + +#### overridden_child_entities.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**IdentifierDuplications**]({{complexTypePrefix}}IdentifierDuplications.md) | [**IdentifierDuplications**]({{complexTypePrefix}}IdentifierDuplications.md) | [**IdentifierDuplications**]({{complexTypePrefix}}IdentifierDuplications.md) | | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/IdentityProvidersApi.md b/gooddata-api-client/docs/apis/tags/IdentityProvidersApi.md new file mode 100644 index 000000000..6d6e0b271 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/IdentityProvidersApi.md @@ -0,0 +1,1087 @@ + +# gooddata_api_client.apis.tags.identity_providers_api.IdentityProvidersApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_identity_providers**](#create_entity_identity_providers) | **post** /api/v1/entities/identityProviders | Post Identity Providers +[**delete_entity_identity_providers**](#delete_entity_identity_providers) | **delete** /api/v1/entities/identityProviders/{id} | Delete Identity Provider +[**get_all_entities_identity_providers**](#get_all_entities_identity_providers) | **get** /api/v1/entities/identityProviders | Get all Identity Providers +[**get_entity_identity_providers**](#get_entity_identity_providers) | **get** /api/v1/entities/identityProviders/{id} | Get Identity Provider +[**get_identity_providers_layout**](#get_identity_providers_layout) | **get** /api/v1/layout/identityProviders | Get all identity providers layout +[**patch_entity_identity_providers**](#patch_entity_identity_providers) | **patch** /api/v1/entities/identityProviders/{id} | Patch Identity Provider +[**set_identity_providers**](#set_identity_providers) | **put** /api/v1/layout/identityProviders | Set all identity providers +[**update_entity_identity_providers**](#update_entity_identity_providers) | **put** /api/v1/entities/identityProviders/{id} | Put Identity Provider + +# **create_entity_identity_providers** + +> JsonApiIdentityProviderOutDocument create_entity_identity_providers(json_api_identity_provider_in_document) + +Post Identity Providers + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import identity_providers_api +from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = identity_providers_api.IdentityProvidersApi(api_client) + + # example passing only required values which don't have defaults set + body = JsonApiIdentityProviderInDocument( + data=JsonApiIdentityProviderIn( + attributes=dict( + custom_claim_mapping=dict( + "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=dict( + "key": "key_example", + ), + oauth_custom_scopes=[ + "oauth_custom_scopes_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="identityProvider", + ), + ) + try: + # Post Identity Providers + api_response = api_instance.create_entity_identity_providers( + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling IdentityProvidersApi->create_entity_identity_providers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiIdentityProviderInDocument**](../../models/JsonApiIdentityProviderInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiIdentityProviderInDocument**](../../models/JsonApiIdentityProviderInDocument.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_entity_identity_providers.ApiResponseFor201) | Request successfully processed + +#### create_entity_identity_providers.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, SchemaFor201ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiIdentityProviderOutDocument**](../../models/JsonApiIdentityProviderOutDocument.md) | | + + +# SchemaFor201ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiIdentityProviderOutDocument**](../../models/JsonApiIdentityProviderOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 Identity Provider + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import identity_providers_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(configuration) as api_client: + # Create an instance of the API class + api_instance = identity_providers_api.IdentityProvidersApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + try: + # Delete Identity Provider + api_response = api_instance.delete_entity_identity_providers( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling IdentityProvidersApi->delete_entity_identity_providers: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "identifiers==v1,v2,v3;customClaimMapping==MapValue", + } + try: + # Delete Identity Provider + api_response = api_instance.delete_entity_identity_providers( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling IdentityProvidersApi->delete_entity_identity_providers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_entity_identity_providers.ApiResponseFor204) | Successfully deleted + +#### delete_entity_identity_providers.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 Identity Providers + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import identity_providers_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = identity_providers_api.IdentityProvidersApi(api_client) + + # example passing only optional values + query_params = { + 'filter': "identifiers==v1,v2,v3;customClaimMapping==MapValue", + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=page,all" + ], + } + try: + # Get all Identity Providers + api_response = api_instance.get_all_entities_identity_providers( + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling IdentityProvidersApi->get_all_entities_identity_providers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["page", "all", "ALL", ] + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_entities_identity_providers.ApiResponseFor200) | Request successfully processed + +#### get_all_entities_identity_providers.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiIdentityProviderOutList**](../../models/JsonApiIdentityProviderOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiIdentityProviderOutList**](../../models/JsonApiIdentityProviderOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_entity_identity_providers** + +> JsonApiIdentityProviderOutDocument get_entity_identity_providers(id) + +Get Identity Provider + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import identity_providers_api +from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = identity_providers_api.IdentityProvidersApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + try: + # Get Identity Provider + api_response = api_instance.get_entity_identity_providers( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling IdentityProvidersApi->get_entity_identity_providers: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "identifiers==v1,v2,v3;customClaimMapping==MapValue", + } + try: + # Get Identity Provider + api_response = api_instance.get_entity_identity_providers( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling IdentityProvidersApi->get_entity_identity_providers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_entity_identity_providers.ApiResponseFor200) | Request successfully processed + +#### get_entity_identity_providers.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiIdentityProviderOutDocument**](../../models/JsonApiIdentityProviderOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiIdentityProviderOutDocument**](../../models/JsonApiIdentityProviderOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_identity_providers_layout** + +> [DeclarativeIdentityProvider] get_identity_providers_layout() + +Get all identity providers layout + +Gets complete layout of identity providers. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import identity_providers_api +from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = identity_providers_api.IdentityProvidersApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Get all identity providers layout + api_response = api_instance.get_identity_providers_layout() + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling IdentityProvidersApi->get_identity_providers_layout: %s\n" % e) +``` +### Parameters +This endpoint does not need any parameter. + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_identity_providers_layout.ApiResponseFor200) | Retrieved layout of all identity providers. + +#### get_identity_providers_layout.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DeclarativeIdentityProvider**]({{complexTypePrefix}}DeclarativeIdentityProvider.md) | [**DeclarativeIdentityProvider**]({{complexTypePrefix}}DeclarativeIdentityProvider.md) | [**DeclarativeIdentityProvider**]({{complexTypePrefix}}DeclarativeIdentityProvider.md) | | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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(idjson_api_identity_provider_patch_document) + +Patch Identity Provider + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import identity_providers_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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = identity_providers_api.IdentityProvidersApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + body = JsonApiIdentityProviderPatchDocument( + data=JsonApiIdentityProviderPatch( + attributes=dict( + custom_claim_mapping=dict( + "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=dict( + "key": "key_example", + ), + oauth_custom_scopes=[ + "oauth_custom_scopes_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="identityProvider", + ), + ) + try: + # Patch Identity Provider + api_response = api_instance.patch_entity_identity_providers( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling IdentityProvidersApi->patch_entity_identity_providers: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "identifiers==v1,v2,v3;customClaimMapping==MapValue", + } + body = JsonApiIdentityProviderPatchDocument( + data=JsonApiIdentityProviderPatch( + attributes=dict( + custom_claim_mapping=dict( + "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=dict( + "key": "key_example", + ), + oauth_custom_scopes=[ + "oauth_custom_scopes_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="identityProvider", + ), + ) + try: + # Patch Identity Provider + api_response = api_instance.patch_entity_identity_providers( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling IdentityProvidersApi->patch_entity_identity_providers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiIdentityProviderPatchDocument**](../../models/JsonApiIdentityProviderPatchDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiIdentityProviderPatchDocument**](../../models/JsonApiIdentityProviderPatchDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#patch_entity_identity_providers.ApiResponseFor200) | Request successfully processed + +#### patch_entity_identity_providers.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiIdentityProviderOutDocument**](../../models/JsonApiIdentityProviderOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiIdentityProviderOutDocument**](../../models/JsonApiIdentityProviderOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **set_identity_providers** + +> set_identity_providers(declarative_identity_provider) + +Set all identity providers + +Sets identity providers in organization. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import identity_providers_api +from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = identity_providers_api.IdentityProvidersApi(api_client) + + # example passing only required values which don't have defaults set + body = [ + DeclarativeIdentityProvider( + custom_claim_mapping=dict( + "key": "key_example", + ), + id="filterView-1", + 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=dict( + "key": "key_example", + ), + oauth_custom_scopes=[ + "oauth_custom_scopes_example" + ], + oauth_issuer_id="myOidcProvider", + oauth_issuer_location="oauth_issuer_location_example", + oauth_subject_id_claim="oid", + saml_metadata="saml_metadata_example", + ) + ] + try: + # Set all identity providers + api_response = api_instance.set_identity_providers( + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling IdentityProvidersApi->set_identity_providers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DeclarativeIdentityProvider**]({{complexTypePrefix}}DeclarativeIdentityProvider.md) | [**DeclarativeIdentityProvider**]({{complexTypePrefix}}DeclarativeIdentityProvider.md) | [**DeclarativeIdentityProvider**]({{complexTypePrefix}}DeclarativeIdentityProvider.md) | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#set_identity_providers.ApiResponseFor204) | All identity providers set. + +#### set_identity_providers.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_identity_providers** + +> JsonApiIdentityProviderOutDocument update_entity_identity_providers(idjson_api_identity_provider_in_document) + +Put Identity Provider + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import identity_providers_api +from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = identity_providers_api.IdentityProvidersApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + body = JsonApiIdentityProviderInDocument( + data=JsonApiIdentityProviderIn( + attributes=dict( + custom_claim_mapping=dict( + "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=dict( + "key": "key_example", + ), + oauth_custom_scopes=[ + "oauth_custom_scopes_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="identityProvider", + ), + ) + try: + # Put Identity Provider + api_response = api_instance.update_entity_identity_providers( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling IdentityProvidersApi->update_entity_identity_providers: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "identifiers==v1,v2,v3;customClaimMapping==MapValue", + } + body = JsonApiIdentityProviderInDocument( + data=JsonApiIdentityProviderIn( + attributes=dict( + custom_claim_mapping=dict( + "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=dict( + "key": "key_example", + ), + oauth_custom_scopes=[ + "oauth_custom_scopes_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="identityProvider", + ), + ) + try: + # Put Identity Provider + api_response = api_instance.update_entity_identity_providers( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling IdentityProvidersApi->update_entity_identity_providers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiIdentityProviderInDocument**](../../models/JsonApiIdentityProviderInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiIdentityProviderInDocument**](../../models/JsonApiIdentityProviderInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#update_entity_identity_providers.ApiResponseFor200) | Request successfully processed + +#### update_entity_identity_providers.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiIdentityProviderOutDocument**](../../models/JsonApiIdentityProviderOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiIdentityProviderOutDocument**](../../models/JsonApiIdentityProviderOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/ImageExportApi.md b/gooddata-api-client/docs/apis/tags/ImageExportApi.md new file mode 100644 index 000000000..942740e22 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/ImageExportApi.md @@ -0,0 +1,362 @@ + +# gooddata_api_client.apis.tags.image_export_api.ImageExportApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_image_export**](#create_image_export) | **post** /api/v1/actions/workspaces/{workspaceId}/export/image | (EXPERIMENTAL) Create image export request +[**get_image_export**](#get_image_export) | **get** /api/v1/actions/workspaces/{workspaceId}/export/image/{exportId} | (EXPERIMENTAL) Retrieve exported files +[**get_image_export_metadata**](#get_image_export_metadata) | **get** /api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context + +# **create_image_export** + +> ExportResponse create_image_export(workspace_idimage_export_request) + +(EXPERIMENTAL) Create image export request + +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. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import image_export_api +from gooddata_api_client.model.export_response import ExportResponse +from gooddata_api_client.model.image_export_request import ImageExportRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = image_export_api.ImageExportApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = ImageExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PNG", + metadata=JsonNode(), + widget_ids=[ + "widget_ids_example" + ], + ) + try: + # (EXPERIMENTAL) Create image export request + api_response = api_instance.create_image_export( + path_params=path_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ImageExportApi->create_image_export: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ImageExportRequest**](../../models/ImageExportRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_image_export.ApiResponseFor201) | Image export request created successfully. + +#### create_image_export.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ExportResponse**](../../models/ExportResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_image_export** + +> file_type get_image_export(workspace_idexport_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 gooddata_api_client +from gooddata_api_client.apis.tags import image_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(configuration) as api_client: + # Create an instance of the API class + api_instance = image_export_api.ImageExportApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'exportId': "exportId_example", + } + try: + # (EXPERIMENTAL) Retrieve exported files + api_response = api_instance.get_image_export( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ImageExportApi->get_image_export: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('image/png', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +exportId | ExportIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ExportIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_image_export.ApiResponseFor200) | Binary export result. +202 | [ApiResponseFor202](#get_image_export.ApiResponseFor202) | Request is accepted, provided exportId exists, but export is not yet ready. + +#### get_image_export.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyImagePng, ] | | +headers | ResponseHeadersFor200 | | + +# SchemaFor200ResponseBodyImagePng + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | +#### ResponseHeadersFor200 + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +Content-Disposition | ContentDispositionSchema | | optional + +# ContentDispositionSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + + +#### get_image_export.ApiResponseFor202 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor202ResponseBodyImagePng, ] | | +headers | Unset | headers were not defined | + +# SchemaFor202ResponseBodyImagePng + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**char** | str, | str, | | [optional] +**direct** | bool, | BoolClass, | | [optional] +**double** | decimal.Decimal, int, float, | decimal.Decimal, | | [optional] value must be a 64 bit float +**float** | decimal.Decimal, int, float, | decimal.Decimal, | | [optional] value must be a 32 bit float +**int** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer +**long** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 64 bit integer +**readOnly** | bool, | BoolClass, | | [optional] +**short** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_image_export_metadata** + +> get_image_export_metadata(workspace_idexport_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/image endpoint. The metadata structure is not verified. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import image_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(configuration) as api_client: + # Create an instance of the API class + api_instance = image_export_api.ImageExportApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'exportId': "exportId_example", + } + try: + # (EXPERIMENTAL) Retrieve metadata context + api_response = api_instance.get_image_export_metadata( + path_params=path_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling ImageExportApi->get_image_export_metadata: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +exportId | ExportIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ExportIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_image_export_metadata.ApiResponseFor200) | Json metadata representation + +#### get_image_export_metadata.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[Unset, ] | | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/JWKSApi.md b/gooddata-api-client/docs/apis/tags/JWKSApi.md new file mode 100644 index 000000000..cd67115b2 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/JWKSApi.md @@ -0,0 +1,847 @@ + +# gooddata_api_client.apis.tags.jwks_api.JWKSApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_jwks**](#create_entity_jwks) | **post** /api/v1/entities/jwks | Post Jwks +[**delete_entity_jwks**](#delete_entity_jwks) | **delete** /api/v1/entities/jwks/{id} | Delete Jwk +[**get_all_entities_jwks**](#get_all_entities_jwks) | **get** /api/v1/entities/jwks | Get all Jwks +[**get_entity_jwks**](#get_entity_jwks) | **get** /api/v1/entities/jwks/{id} | Get Jwk +[**patch_entity_jwks**](#patch_entity_jwks) | **patch** /api/v1/entities/jwks/{id} | Patch Jwk +[**update_entity_jwks**](#update_entity_jwks) | **put** /api/v1/entities/jwks/{id} | Put Jwk + +# **create_entity_jwks** + +> JsonApiJwkOutDocument create_entity_jwks(json_api_jwk_in_document) + +Post Jwks + +Creates JSON web key - used to verify JSON web tokens (Jwts) + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import jwks_api +from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = jwks_api.JWKSApi(api_client) + + # example passing only required values which don't have defaults set + body = JsonApiJwkInDocument( + data=JsonApiJwkIn( + attributes=dict( + content=dict(), + ), + id="id1", + type="jwk", + ), + ) + try: + # Post Jwks + api_response = api_instance.create_entity_jwks( + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling JWKSApi->create_entity_jwks: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiJwkInDocument**](../../models/JsonApiJwkInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiJwkInDocument**](../../models/JsonApiJwkInDocument.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_entity_jwks.ApiResponseFor201) | Request successfully processed + +#### create_entity_jwks.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, SchemaFor201ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiJwkOutDocument**](../../models/JsonApiJwkOutDocument.md) | | + + +# SchemaFor201ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiJwkOutDocument**](../../models/JsonApiJwkOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 + +Deletes JSON web key - used to verify JSON web tokens (Jwts) + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import jwks_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(configuration) as api_client: + # Create an instance of the API class + api_instance = jwks_api.JWKSApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + try: + # Delete Jwk + api_response = api_instance.delete_entity_jwks( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling JWKSApi->delete_entity_jwks: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "content==JwkSpecificationValue", + } + try: + # Delete Jwk + api_response = api_instance.delete_entity_jwks( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling JWKSApi->delete_entity_jwks: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_entity_jwks.ApiResponseFor204) | Successfully deleted + +#### delete_entity_jwks.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_all_entities_jwks** + +> JsonApiJwkOutList get_all_entities_jwks() + +Get all Jwks + +Returns all JSON web keys - used to verify JSON web tokens (Jwts) + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import jwks_api +from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = jwks_api.JWKSApi(api_client) + + # example passing only optional values + query_params = { + 'filter': "content==JwkSpecificationValue", + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=page,all" + ], + } + try: + # Get all Jwks + api_response = api_instance.get_all_entities_jwks( + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling JWKSApi->get_all_entities_jwks: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["page", "all", "ALL", ] + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_entities_jwks.ApiResponseFor200) | Request successfully processed + +#### get_all_entities_jwks.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiJwkOutList**](../../models/JsonApiJwkOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiJwkOutList**](../../models/JsonApiJwkOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 + +Returns JSON web key - used to verify JSON web tokens (Jwts) + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import jwks_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = jwks_api.JWKSApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + try: + # Get Jwk + api_response = api_instance.get_entity_jwks( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling JWKSApi->get_entity_jwks: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "content==JwkSpecificationValue", + } + try: + # Get Jwk + api_response = api_instance.get_entity_jwks( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling JWKSApi->get_entity_jwks: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_entity_jwks.ApiResponseFor200) | Request successfully processed + +#### get_entity_jwks.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiJwkOutDocument**](../../models/JsonApiJwkOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiJwkOutDocument**](../../models/JsonApiJwkOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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(idjson_api_jwk_patch_document) + +Patch Jwk + +Patches JSON web key - used to verify JSON web tokens (Jwts) + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import jwks_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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = jwks_api.JWKSApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + body = JsonApiJwkPatchDocument( + data=JsonApiJwkPatch( + attributes=dict( + content=dict(), + ), + id="id1", + type="jwk", + ), + ) + try: + # Patch Jwk + api_response = api_instance.patch_entity_jwks( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling JWKSApi->patch_entity_jwks: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "content==JwkSpecificationValue", + } + body = JsonApiJwkPatchDocument( + data=JsonApiJwkPatch( + attributes=dict( + content=dict(), + ), + id="id1", + type="jwk", + ), + ) + try: + # Patch Jwk + api_response = api_instance.patch_entity_jwks( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling JWKSApi->patch_entity_jwks: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiJwkPatchDocument**](../../models/JsonApiJwkPatchDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiJwkPatchDocument**](../../models/JsonApiJwkPatchDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#patch_entity_jwks.ApiResponseFor200) | Request successfully processed + +#### patch_entity_jwks.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiJwkOutDocument**](../../models/JsonApiJwkOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiJwkOutDocument**](../../models/JsonApiJwkOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_jwks** + +> JsonApiJwkOutDocument update_entity_jwks(idjson_api_jwk_in_document) + +Put Jwk + +Updates JSON web key - used to verify JSON web tokens (Jwts) + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import jwks_api +from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = jwks_api.JWKSApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + body = JsonApiJwkInDocument( + data=JsonApiJwkIn( + attributes=dict( + content=dict(), + ), + id="id1", + type="jwk", + ), + ) + try: + # Put Jwk + api_response = api_instance.update_entity_jwks( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling JWKSApi->update_entity_jwks: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "content==JwkSpecificationValue", + } + body = JsonApiJwkInDocument( + data=JsonApiJwkIn( + attributes=dict( + content=dict(), + ), + id="id1", + type="jwk", + ), + ) + try: + # Put Jwk + api_response = api_instance.update_entity_jwks( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling JWKSApi->update_entity_jwks: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiJwkInDocument**](../../models/JsonApiJwkInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiJwkInDocument**](../../models/JsonApiJwkInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#update_entity_jwks.ApiResponseFor200) | Request successfully processed + +#### update_entity_jwks.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiJwkOutDocument**](../../models/JsonApiJwkOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiJwkOutDocument**](../../models/JsonApiJwkOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/LLMEndpointsApi.md b/gooddata-api-client/docs/apis/tags/LLMEndpointsApi.md new file mode 100644 index 000000000..58adc25a6 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/LLMEndpointsApi.md @@ -0,0 +1,858 @@ + +# gooddata_api_client.apis.tags.llm_endpoints_api.LLMEndpointsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_llm_endpoints**](#create_entity_llm_endpoints) | **post** /api/v1/entities/llmEndpoints | Post LLM endpoint entities +[**delete_entity_llm_endpoints**](#delete_entity_llm_endpoints) | **delete** /api/v1/entities/llmEndpoints/{id} | +[**get_all_entities_llm_endpoints**](#get_all_entities_llm_endpoints) | **get** /api/v1/entities/llmEndpoints | Get all LLM endpoint entities +[**get_entity_llm_endpoints**](#get_entity_llm_endpoints) | **get** /api/v1/entities/llmEndpoints/{id} | Get LLM endpoint entity +[**patch_entity_llm_endpoints**](#patch_entity_llm_endpoints) | **patch** /api/v1/entities/llmEndpoints/{id} | Patch LLM endpoint entity +[**update_entity_llm_endpoints**](#update_entity_llm_endpoints) | **put** /api/v1/entities/llmEndpoints/{id} | PUT LLM endpoint entity + +# **create_entity_llm_endpoints** + +> JsonApiLlmEndpointOutDocument create_entity_llm_endpoints(json_api_llm_endpoint_in_document) + +Post LLM endpoint entities + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import llm_endpoints_api +from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = llm_endpoints_api.LLMEndpointsApi(api_client) + + # example passing only required values which don't have defaults set + body = JsonApiLlmEndpointInDocument( + data=JsonApiLlmEndpointIn( + attributes=dict( + base_url="base_url_example", + llm_model="llm_model_example", + llm_organization="llm_organization_example", + provider="OPENAI", + title="title_example", + token="token_example", + ), + id="id1", + type="llmEndpoint", + ), + ) + try: + # Post LLM endpoint entities + api_response = api_instance.create_entity_llm_endpoints( + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMEndpointsApi->create_entity_llm_endpoints: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmEndpointInDocument**](../../models/JsonApiLlmEndpointInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmEndpointInDocument**](../../models/JsonApiLlmEndpointInDocument.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_entity_llm_endpoints.ApiResponseFor201) | Request successfully processed + +#### create_entity_llm_endpoints.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, SchemaFor201ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmEndpointOutDocument**](../../models/JsonApiLlmEndpointOutDocument.md) | | + + +# SchemaFor201ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmEndpointOutDocument**](../../models/JsonApiLlmEndpointOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_endpoints** + +> delete_entity_llm_endpoints(id) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import llm_endpoints_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(configuration) as api_client: + # Create an instance of the API class + api_instance = llm_endpoints_api.LLMEndpointsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + try: + api_response = api_instance.delete_entity_llm_endpoints( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMEndpointsApi->delete_entity_llm_endpoints: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "title==someString;provider==LlmEndpointProviderValue", + } + try: + api_response = api_instance.delete_entity_llm_endpoints( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMEndpointsApi->delete_entity_llm_endpoints: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_entity_llm_endpoints.ApiResponseFor204) | Successfully deleted + +#### delete_entity_llm_endpoints.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_endpoints** + +> JsonApiLlmEndpointOutList get_all_entities_llm_endpoints() + +Get all LLM endpoint entities + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import llm_endpoints_api +from gooddata_api_client.model.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = llm_endpoints_api.LLMEndpointsApi(api_client) + + # example passing only optional values + query_params = { + 'filter': "title==someString;provider==LlmEndpointProviderValue", + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=page,all" + ], + } + try: + # Get all LLM endpoint entities + api_response = api_instance.get_all_entities_llm_endpoints( + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMEndpointsApi->get_all_entities_llm_endpoints: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["page", "all", "ALL", ] + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_entities_llm_endpoints.ApiResponseFor200) | Request successfully processed + +#### get_all_entities_llm_endpoints.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmEndpointOutList**](../../models/JsonApiLlmEndpointOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmEndpointOutList**](../../models/JsonApiLlmEndpointOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_endpoints** + +> JsonApiLlmEndpointOutDocument get_entity_llm_endpoints(id) + +Get LLM endpoint entity + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import llm_endpoints_api +from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = llm_endpoints_api.LLMEndpointsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + try: + # Get LLM endpoint entity + api_response = api_instance.get_entity_llm_endpoints( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMEndpointsApi->get_entity_llm_endpoints: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "title==someString;provider==LlmEndpointProviderValue", + } + try: + # Get LLM endpoint entity + api_response = api_instance.get_entity_llm_endpoints( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMEndpointsApi->get_entity_llm_endpoints: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_entity_llm_endpoints.ApiResponseFor200) | Request successfully processed + +#### get_entity_llm_endpoints.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmEndpointOutDocument**](../../models/JsonApiLlmEndpointOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmEndpointOutDocument**](../../models/JsonApiLlmEndpointOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_endpoints** + +> JsonApiLlmEndpointOutDocument patch_entity_llm_endpoints(idjson_api_llm_endpoint_patch_document) + +Patch LLM endpoint entity + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import llm_endpoints_api +from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.model.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = llm_endpoints_api.LLMEndpointsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + body = JsonApiLlmEndpointPatchDocument( + data=JsonApiLlmEndpointPatch( + attributes=dict( + base_url="base_url_example", + llm_model="llm_model_example", + llm_organization="llm_organization_example", + provider="OPENAI", + title="title_example", + token="token_example", + ), + id="id1", + type="llmEndpoint", + ), + ) + try: + # Patch LLM endpoint entity + api_response = api_instance.patch_entity_llm_endpoints( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMEndpointsApi->patch_entity_llm_endpoints: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "title==someString;provider==LlmEndpointProviderValue", + } + body = JsonApiLlmEndpointPatchDocument( + data=JsonApiLlmEndpointPatch( + attributes=dict( + base_url="base_url_example", + llm_model="llm_model_example", + llm_organization="llm_organization_example", + provider="OPENAI", + title="title_example", + token="token_example", + ), + id="id1", + type="llmEndpoint", + ), + ) + try: + # Patch LLM endpoint entity + api_response = api_instance.patch_entity_llm_endpoints( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMEndpointsApi->patch_entity_llm_endpoints: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmEndpointPatchDocument**](../../models/JsonApiLlmEndpointPatchDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmEndpointPatchDocument**](../../models/JsonApiLlmEndpointPatchDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#patch_entity_llm_endpoints.ApiResponseFor200) | Request successfully processed + +#### patch_entity_llm_endpoints.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmEndpointOutDocument**](../../models/JsonApiLlmEndpointOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmEndpointOutDocument**](../../models/JsonApiLlmEndpointOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_llm_endpoints** + +> JsonApiLlmEndpointOutDocument update_entity_llm_endpoints(idjson_api_llm_endpoint_in_document) + +PUT LLM endpoint entity + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import llm_endpoints_api +from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = llm_endpoints_api.LLMEndpointsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + body = JsonApiLlmEndpointInDocument( + data=JsonApiLlmEndpointIn( + attributes=dict( + base_url="base_url_example", + llm_model="llm_model_example", + llm_organization="llm_organization_example", + provider="OPENAI", + title="title_example", + token="token_example", + ), + id="id1", + type="llmEndpoint", + ), + ) + try: + # PUT LLM endpoint entity + api_response = api_instance.update_entity_llm_endpoints( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMEndpointsApi->update_entity_llm_endpoints: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "title==someString;provider==LlmEndpointProviderValue", + } + body = JsonApiLlmEndpointInDocument( + data=JsonApiLlmEndpointIn( + attributes=dict( + base_url="base_url_example", + llm_model="llm_model_example", + llm_organization="llm_organization_example", + provider="OPENAI", + title="title_example", + token="token_example", + ), + id="id1", + type="llmEndpoint", + ), + ) + try: + # PUT LLM endpoint entity + api_response = api_instance.update_entity_llm_endpoints( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMEndpointsApi->update_entity_llm_endpoints: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmEndpointInDocument**](../../models/JsonApiLlmEndpointInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmEndpointInDocument**](../../models/JsonApiLlmEndpointInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#update_entity_llm_endpoints.ApiResponseFor200) | Request successfully processed + +#### update_entity_llm_endpoints.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmEndpointOutDocument**](../../models/JsonApiLlmEndpointOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmEndpointOutDocument**](../../models/JsonApiLlmEndpointOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/LLMProvidersApi.md b/gooddata-api-client/docs/apis/tags/LLMProvidersApi.md new file mode 100644 index 000000000..5adef760b --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/LLMProvidersApi.md @@ -0,0 +1,882 @@ + +# gooddata_api_client.apis.tags.llm_providers_api.LLMProvidersApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_llm_providers**](#create_entity_llm_providers) | **post** /api/v1/entities/llmProviders | Post LLM Provider entities +[**delete_entity_llm_providers**](#delete_entity_llm_providers) | **delete** /api/v1/entities/llmProviders/{id} | Delete LLM Provider entity +[**get_all_entities_llm_providers**](#get_all_entities_llm_providers) | **get** /api/v1/entities/llmProviders | Get all LLM Provider entities +[**get_entity_llm_providers**](#get_entity_llm_providers) | **get** /api/v1/entities/llmProviders/{id} | Get LLM Provider entity +[**patch_entity_llm_providers**](#patch_entity_llm_providers) | **patch** /api/v1/entities/llmProviders/{id} | Patch LLM Provider entity +[**update_entity_llm_providers**](#update_entity_llm_providers) | **put** /api/v1/entities/llmProviders/{id} | PUT LLM Provider entity + +# **create_entity_llm_providers** + +> JsonApiLlmProviderOutDocument create_entity_llm_providers(json_api_llm_provider_in_document) + +Post LLM Provider entities + +LLM Provider - connection configuration for LLM services + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import llm_providers_api +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument +from gooddata_api_client.model.json_api_llm_provider_in_document import JsonApiLlmProviderInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = llm_providers_api.LLMProvidersApi(api_client) + + # example passing only required values which don't have defaults set + body = JsonApiLlmProviderInDocument( + data=JsonApiLlmProviderIn( + attributes=dict( + default_model_id="default_model_id_example", + description="description_example", + models=[ + dict( + family="OPENAI", + id="id_example", + ) + ], + name="name_example", + provider_config=None, + ), + id="id1", + type="llmProvider", + ), + ) + try: + # Post LLM Provider entities + api_response = api_instance.create_entity_llm_providers( + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->create_entity_llm_providers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmProviderInDocument**](../../models/JsonApiLlmProviderInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmProviderInDocument**](../../models/JsonApiLlmProviderInDocument.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_entity_llm_providers.ApiResponseFor201) | Request successfully processed + +#### create_entity_llm_providers.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, SchemaFor201ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmProviderOutDocument**](../../models/JsonApiLlmProviderOutDocument.md) | | + + +# SchemaFor201ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmProviderOutDocument**](../../models/JsonApiLlmProviderOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 LLM Provider entity + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import llm_providers_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(configuration) as api_client: + # Create an instance of the API class + api_instance = llm_providers_api.LLMProvidersApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + try: + # Delete LLM Provider entity + api_response = api_instance.delete_entity_llm_providers( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->delete_entity_llm_providers: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;description==someString", + } + try: + # Delete LLM Provider entity + api_response = api_instance.delete_entity_llm_providers( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->delete_entity_llm_providers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_entity_llm_providers.ApiResponseFor204) | Successfully deleted + +#### delete_entity_llm_providers.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 LLM Provider entities + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import llm_providers_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = llm_providers_api.LLMProvidersApi(api_client) + + # example passing only optional values + query_params = { + 'filter': "name==someString;description==someString", + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=page,all" + ], + } + try: + # Get all LLM Provider entities + api_response = api_instance.get_all_entities_llm_providers( + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->get_all_entities_llm_providers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["page", "all", "ALL", ] + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_entities_llm_providers.ApiResponseFor200) | Request successfully processed + +#### get_all_entities_llm_providers.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmProviderOutList**](../../models/JsonApiLlmProviderOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmProviderOutList**](../../models/JsonApiLlmProviderOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 LLM Provider entity + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import llm_providers_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = llm_providers_api.LLMProvidersApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + try: + # Get LLM Provider entity + api_response = api_instance.get_entity_llm_providers( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->get_entity_llm_providers: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;description==someString", + } + try: + # Get LLM Provider entity + api_response = api_instance.get_entity_llm_providers( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->get_entity_llm_providers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_entity_llm_providers.ApiResponseFor200) | Request successfully processed + +#### get_entity_llm_providers.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmProviderOutDocument**](../../models/JsonApiLlmProviderOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmProviderOutDocument**](../../models/JsonApiLlmProviderOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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(idjson_api_llm_provider_patch_document) + +Patch LLM Provider entity + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import llm_providers_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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = llm_providers_api.LLMProvidersApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + body = JsonApiLlmProviderPatchDocument( + data=JsonApiLlmProviderPatch( + attributes=dict( + default_model_id="default_model_id_example", + description="description_example", + models=[ + dict( + family="OPENAI", + id="id_example", + ) + ], + name="name_example", + provider_config=None, + ), + id="id1", + type="llmProvider", + ), + ) + try: + # Patch LLM Provider entity + api_response = api_instance.patch_entity_llm_providers( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->patch_entity_llm_providers: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;description==someString", + } + body = JsonApiLlmProviderPatchDocument( + data=JsonApiLlmProviderPatch( + attributes=dict( + default_model_id="default_model_id_example", + description="description_example", + models=[ + dict( + family="OPENAI", + id="id_example", + ) + ], + name="name_example", + provider_config=None, + ), + id="id1", + type="llmProvider", + ), + ) + try: + # Patch LLM Provider entity + api_response = api_instance.patch_entity_llm_providers( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->patch_entity_llm_providers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmProviderPatchDocument**](../../models/JsonApiLlmProviderPatchDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmProviderPatchDocument**](../../models/JsonApiLlmProviderPatchDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#patch_entity_llm_providers.ApiResponseFor200) | Request successfully processed + +#### patch_entity_llm_providers.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmProviderOutDocument**](../../models/JsonApiLlmProviderOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmProviderOutDocument**](../../models/JsonApiLlmProviderOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_llm_providers** + +> JsonApiLlmProviderOutDocument update_entity_llm_providers(idjson_api_llm_provider_in_document) + +PUT LLM Provider entity + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import llm_providers_api +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument +from gooddata_api_client.model.json_api_llm_provider_in_document import JsonApiLlmProviderInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = llm_providers_api.LLMProvidersApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + body = JsonApiLlmProviderInDocument( + data=JsonApiLlmProviderIn( + attributes=dict( + default_model_id="default_model_id_example", + description="description_example", + models=[ + dict( + family="OPENAI", + id="id_example", + ) + ], + name="name_example", + provider_config=None, + ), + id="id1", + type="llmProvider", + ), + ) + try: + # PUT LLM Provider entity + api_response = api_instance.update_entity_llm_providers( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->update_entity_llm_providers: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;description==someString", + } + body = JsonApiLlmProviderInDocument( + data=JsonApiLlmProviderIn( + attributes=dict( + default_model_id="default_model_id_example", + description="description_example", + models=[ + dict( + family="OPENAI", + id="id_example", + ) + ], + name="name_example", + provider_config=None, + ), + id="id1", + type="llmProvider", + ), + ) + try: + # PUT LLM Provider entity + api_response = api_instance.update_entity_llm_providers( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LLMProvidersApi->update_entity_llm_providers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmProviderInDocument**](../../models/JsonApiLlmProviderInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmProviderInDocument**](../../models/JsonApiLlmProviderInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#update_entity_llm_providers.ApiResponseFor200) | Request successfully processed + +#### update_entity_llm_providers.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmProviderOutDocument**](../../models/JsonApiLlmProviderOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiLlmProviderOutDocument**](../../models/JsonApiLlmProviderOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/ManagePermissionsApi.md b/gooddata-api-client/docs/apis/tags/ManagePermissionsApi.md new file mode 100644 index 000000000..4d7a0050f --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/ManagePermissionsApi.md @@ -0,0 +1,314 @@ + +# gooddata_api_client.apis.tags.manage_permissions_api.ManagePermissionsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_data_source_permissions**](#get_data_source_permissions) | **get** /api/v1/layout/dataSources/{dataSourceId}/permissions | Get permissions for the data source +[**manage_data_source_permissions**](#manage_data_source_permissions) | **post** /api/v1/actions/dataSources/{dataSourceId}/managePermissions | Manage Permissions for a Data Source +[**set_data_source_permissions**](#set_data_source_permissions) | **put** /api/v1/layout/dataSources/{dataSourceId}/permissions | Set data source permissions. + +# **get_data_source_permissions** + +> DeclarativeDataSourcePermissions get_data_source_permissions(data_source_id) + +Get permissions for the data source + +Retrieve current set of permissions of the data source in a declarative form. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import manage_permissions_api +from gooddata_api_client.model.declarative_data_source_permissions import DeclarativeDataSourcePermissions +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = manage_permissions_api.ManagePermissionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'dataSourceId': "dataSourceId_example", + } + try: + # Get permissions for the data source + api_response = api_instance.get_data_source_permissions( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ManagePermissionsApi->get_data_source_permissions: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +dataSourceId | DataSourceIdSchema | | + +# DataSourceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_data_source_permissions.ApiResponseFor200) | Retrieved current set of permissions. + +#### get_data_source_permissions.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**DeclarativeDataSourcePermissions**](../../models/DeclarativeDataSourcePermissions.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_data_source_permissions** + +> manage_data_source_permissions(data_source_iddata_source_permission_assignment) + +Manage Permissions for a Data Source + +Manage Permissions for a Data Source + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import manage_permissions_api +from gooddata_api_client.model.data_source_permission_assignment import DataSourcePermissionAssignment +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = manage_permissions_api.ManagePermissionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'dataSourceId': "dataSourceId_example", + } + body = [ + DataSourcePermissionAssignment( + assignee_identifier=AssigneeIdentifier( + id="id_example", + type="user", + ), + permissions=[ + "MANAGE" + ], + ) + ] + try: + # Manage Permissions for a Data Source + api_response = api_instance.manage_data_source_permissions( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling ManagePermissionsApi->manage_data_source_permissions: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson + +An array of data source permissions assignments + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | An array of data source permissions assignments | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DataSourcePermissionAssignment**]({{complexTypePrefix}}DataSourcePermissionAssignment.md) | [**DataSourcePermissionAssignment**]({{complexTypePrefix}}DataSourcePermissionAssignment.md) | [**DataSourcePermissionAssignment**]({{complexTypePrefix}}DataSourcePermissionAssignment.md) | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +dataSourceId | DataSourceIdSchema | | + +# DataSourceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#manage_data_source_permissions.ApiResponseFor204) | No Content + +#### manage_data_source_permissions.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **set_data_source_permissions** + +> set_data_source_permissions(data_source_iddeclarative_data_source_permissions) + +Set data source permissions. + +set data source permissions. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import manage_permissions_api +from gooddata_api_client.model.declarative_data_source_permissions import DeclarativeDataSourcePermissions +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = manage_permissions_api.ManagePermissionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'dataSourceId': "dataSourceId_example", + } + body = DeclarativeDataSourcePermissions( + permissions=[ + DeclarativeDataSourcePermission( + assignee=AssigneeIdentifier( + id="id_example", + type="user", + ), + name="MANAGE", + ) + ], + ) + try: + # Set data source permissions. + api_response = api_instance.set_data_source_permissions( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling ManagePermissionsApi->set_data_source_permissions: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**DeclarativeDataSourcePermissions**](../../models/DeclarativeDataSourcePermissions.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +dataSourceId | DataSourceIdSchema | | + +# DataSourceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#set_data_source_permissions.ApiResponseFor204) | No Content + +#### set_data_source_permissions.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/MetadataCheckApi.md b/gooddata-api-client/docs/apis/tags/MetadataCheckApi.md new file mode 100644 index 000000000..744463644 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/MetadataCheckApi.md @@ -0,0 +1,64 @@ + +# gooddata_api_client.apis.tags.metadata_check_api.MetadataCheckApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**metadata_check_organization**](#metadata_check_organization) | **post** /api/v1/actions/organization/metadataCheck | (BETA) Check Organization Metadata Inconsistencies + +# **metadata_check_organization** + +> metadata_check_organization() + +(BETA) Check Organization Metadata Inconsistencies + +(BETA) Temporary solution. Resyncs all organization objects and full workspaces within the organization with target GEN_AI_CHECK. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import metadata_check_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(configuration) as api_client: + # Create an instance of the API class + api_instance = metadata_check_api.MetadataCheckApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # (BETA) Check Organization Metadata Inconsistencies + api_response = api_instance.metadata_check_organization() + except gooddata_api_client.ApiException as e: + print("Exception when calling MetadataCheckApi->metadata_check_organization: %s\n" % e) +``` +### Parameters +This endpoint does not need any parameter. + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#metadata_check_organization.ApiResponseFor200) | OK + +#### metadata_check_organization.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/MetadataSyncApi.md b/gooddata-api-client/docs/apis/tags/MetadataSyncApi.md new file mode 100644 index 000000000..03073b5cc --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/MetadataSyncApi.md @@ -0,0 +1,145 @@ + +# gooddata_api_client.apis.tags.metadata_sync_api.MetadataSyncApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**metadata_sync**](#metadata_sync) | **post** /api/v1/actions/workspaces/{workspaceId}/metadataSync | (BETA) Sync Metadata to other services +[**metadata_sync_organization**](#metadata_sync_organization) | **post** /api/v1/actions/organization/metadataSync | (BETA) Sync organization scope Metadata to other services + +# **metadata_sync** + +> metadata_sync(workspace_id) + +(BETA) Sync Metadata to other services + +(BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import metadata_sync_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = metadata_sync_api.MetadataSyncApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + try: + # (BETA) Sync Metadata to other services + api_response = api_instance.metadata_sync( + path_params=path_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling MetadataSyncApi->metadata_sync: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#metadata_sync.ApiResponseFor200) | OK + +#### metadata_sync.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **metadata_sync_organization** + +> metadata_sync_organization() + +(BETA) Sync organization scope Metadata to other services + +(BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import metadata_sync_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = metadata_sync_api.MetadataSyncApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # (BETA) Sync organization scope Metadata to other services + api_response = api_instance.metadata_sync_organization() + except gooddata_api_client.ApiException as e: + print("Exception when calling MetadataSyncApi->metadata_sync_organization: %s\n" % e) +``` +### Parameters +This endpoint does not need any parameter. + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#metadata_sync_organization.ApiResponseFor200) | OK + +#### metadata_sync_organization.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/NotificationChannelsApi.md b/gooddata-api-client/docs/apis/tags/NotificationChannelsApi.md new file mode 100644 index 000000000..5ef806d09 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/NotificationChannelsApi.md @@ -0,0 +1,1988 @@ + +# gooddata_api_client.apis.tags.notification_channels_api.NotificationChannelsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_notification_channels**](#create_entity_notification_channels) | **post** /api/v1/entities/notificationChannels | Post Notification Channel entities +[**delete_entity_notification_channels**](#delete_entity_notification_channels) | **delete** /api/v1/entities/notificationChannels/{id} | Delete Notification Channel entity +[**get_all_entities_notification_channel_identifiers**](#get_all_entities_notification_channel_identifiers) | **get** /api/v1/entities/notificationChannelIdentifiers | +[**get_all_entities_notification_channels**](#get_all_entities_notification_channels) | **get** /api/v1/entities/notificationChannels | Get all Notification Channel entities +[**get_entity_notification_channel_identifiers**](#get_entity_notification_channel_identifiers) | **get** /api/v1/entities/notificationChannelIdentifiers/{id} | +[**get_entity_notification_channels**](#get_entity_notification_channels) | **get** /api/v1/entities/notificationChannels/{id} | Get Notification Channel entity +[**get_export_templates_layout**](#get_export_templates_layout) | **get** /api/v1/layout/exportTemplates | Get all export templates layout +[**get_notification_channels_layout**](#get_notification_channels_layout) | **get** /api/v1/layout/notificationChannels | Get all notification channels layout +[**get_notifications**](#get_notifications) | **get** /api/v1/actions/notifications | Get latest notifications. +[**mark_as_read_notification**](#mark_as_read_notification) | **post** /api/v1/actions/notifications/{notificationId}/markAsRead | Mark notification as read. +[**mark_as_read_notification_all**](#mark_as_read_notification_all) | **post** /api/v1/actions/notifications/markAsRead | Mark all notifications as read. +[**patch_entity_notification_channels**](#patch_entity_notification_channels) | **patch** /api/v1/entities/notificationChannels/{id} | Patch Notification Channel entity +[**set_export_templates**](#set_export_templates) | **put** /api/v1/layout/exportTemplates | Set all export templates +[**set_notification_channels**](#set_notification_channels) | **put** /api/v1/layout/notificationChannels | Set all notification channels +[**test_existing_notification_channel**](#test_existing_notification_channel) | **post** /api/v1/actions/notificationChannels/{notificationChannelId}/test | Test existing notification channel. +[**test_notification_channel**](#test_notification_channel) | **post** /api/v1/actions/notificationChannels/test | Test notification channel. +[**update_entity_notification_channels**](#update_entity_notification_channels) | **put** /api/v1/entities/notificationChannels/{id} | Put Notification Channel entity + +# **create_entity_notification_channels** + +> JsonApiNotificationChannelOutDocument create_entity_notification_channels(json_api_notification_channel_post_optional_id_document) + +Post Notification Channel entities + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_api +from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.model.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = notification_channels_api.NotificationChannelsApi(api_client) + + # example passing only required values which don't have defaults set + body = JsonApiNotificationChannelPostOptionalIdDocument( + data=JsonApiNotificationChannelPostOptionalId( + attributes=dict( + allowed_recipients="CREATOR", + custom_dashboard_url="custom_dashboard_url_example", + dashboard_link_visibility="HIDDEN", + description="description_example", + destination=None, + in_platform_notification="DISABLED", + name="name_example", + notification_source="notification_source_example", + ), + id="id1", + type="notificationChannel", + ), + ) + try: + # Post Notification Channel entities + api_response = api_instance.create_entity_notification_channels( + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->create_entity_notification_channels: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelPostOptionalIdDocument**](../../models/JsonApiNotificationChannelPostOptionalIdDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelPostOptionalIdDocument**](../../models/JsonApiNotificationChannelPostOptionalIdDocument.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_entity_notification_channels.ApiResponseFor201) | Request successfully processed + +#### create_entity_notification_channels.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, SchemaFor201ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelOutDocument**](../../models/JsonApiNotificationChannelOutDocument.md) | | + + +# SchemaFor201ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelOutDocument**](../../models/JsonApiNotificationChannelOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 Notification Channel entity + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_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(configuration) as api_client: + # Create an instance of the API class + api_instance = notification_channels_api.NotificationChannelsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + try: + # Delete Notification Channel entity + api_response = api_instance.delete_entity_notification_channels( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->delete_entity_notification_channels: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;description==someString", + } + try: + # Delete Notification Channel entity + api_response = api_instance.delete_entity_notification_channels( + path_params=path_params, + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->delete_entity_notification_channels: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#delete_entity_notification_channels.ApiResponseFor204) | Successfully deleted + +#### delete_entity_notification_channels.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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() + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = notification_channels_api.NotificationChannelsApi(api_client) + + # example passing only optional values + query_params = { + 'filter': "name==someString;description==someString", + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=page,all" + ], + } + try: + api_response = api_instance.get_all_entities_notification_channel_identifiers( + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->get_all_entities_notification_channel_identifiers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["page", "all", "ALL", ] + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_entities_notification_channel_identifiers.ApiResponseFor200) | Request successfully processed + +#### get_all_entities_notification_channel_identifiers.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelIdentifierOutList**](../../models/JsonApiNotificationChannelIdentifierOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelIdentifierOutList**](../../models/JsonApiNotificationChannelIdentifierOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 Notification Channel entities + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = notification_channels_api.NotificationChannelsApi(api_client) + + # example passing only optional values + query_params = { + 'filter': "name==someString;description==someString", + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=page,all" + ], + } + try: + # Get all Notification Channel entities + api_response = api_instance.get_all_entities_notification_channels( + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->get_all_entities_notification_channels: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["page", "all", "ALL", ] + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_entities_notification_channels.ApiResponseFor200) | Request successfully processed + +#### get_all_entities_notification_channels.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelOutList**](../../models/JsonApiNotificationChannelOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelOutList**](../../models/JsonApiNotificationChannelOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = notification_channels_api.NotificationChannelsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + try: + api_response = api_instance.get_entity_notification_channel_identifiers( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->get_entity_notification_channel_identifiers: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;description==someString", + } + try: + api_response = api_instance.get_entity_notification_channel_identifiers( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->get_entity_notification_channel_identifiers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_entity_notification_channel_identifiers.ApiResponseFor200) | Request successfully processed + +#### get_entity_notification_channel_identifiers.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelIdentifierOutDocument**](../../models/JsonApiNotificationChannelIdentifierOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelIdentifierOutDocument**](../../models/JsonApiNotificationChannelIdentifierOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 Notification Channel entity + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = notification_channels_api.NotificationChannelsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + try: + # Get Notification Channel entity + api_response = api_instance.get_entity_notification_channels( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->get_entity_notification_channels: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;description==someString", + } + try: + # Get Notification Channel entity + api_response = api_instance.get_entity_notification_channels( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->get_entity_notification_channels: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_entity_notification_channels.ApiResponseFor200) | Request successfully processed + +#### get_entity_notification_channels.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelOutDocument**](../../models/JsonApiNotificationChannelOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelOutDocument**](../../models/JsonApiNotificationChannelOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_export_templates_layout** + +> DeclarativeExportTemplates get_export_templates_layout() + +Get all export templates layout + +Gets complete layout of export templates. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_api +from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = notification_channels_api.NotificationChannelsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Get all export templates layout + api_response = api_instance.get_export_templates_layout() + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->get_export_templates_layout: %s\n" % e) +``` +### Parameters +This endpoint does not need any parameter. + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_export_templates_layout.ApiResponseFor200) | Retrieved layout of all export templates. + +#### get_export_templates_layout.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**DeclarativeExportTemplates**](../../models/DeclarativeExportTemplates.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_notification_channels_layout** + +> DeclarativeNotificationChannels get_notification_channels_layout() + +Get all notification channels layout + +Gets complete layout of notification channels. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_api +from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = notification_channels_api.NotificationChannelsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Get all notification channels layout + api_response = api_instance.get_notification_channels_layout() + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->get_notification_channels_layout: %s\n" % e) +``` +### Parameters +This endpoint does not need any parameter. + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_notification_channels_layout.ApiResponseFor200) | Retrieved layout of all notification channels. + +#### get_notification_channels_layout.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**DeclarativeNotificationChannels**](../../models/DeclarativeNotificationChannels.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_notifications** + +> Notifications get_notifications() + +Get latest notifications. + +Get latest in-platform notifications for the current user. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_api +from gooddata_api_client.model.notifications import Notifications +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = notification_channels_api.NotificationChannelsApi(api_client) + + # example passing only optional values + query_params = { + 'workspaceId': "workspaceId_example", + 'isRead': True, + 'page': "0", + 'size': "20", + 'metaInclude': [ + "total" + ], + } + try: + # Get latest notifications. + api_response = api_instance.get_notifications( + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->get_notifications: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | optional +isRead | IsReadSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# IsReadSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | if omitted the server will use the default value of "0" + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | if omitted the server will use the default value of "20" + +# MetaIncludeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["total", "ALL", ] + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_notifications.ApiResponseFor200) | OK + +#### get_notifications.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**Notifications**](../../models/Notifications.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **mark_as_read_notification** + +> mark_as_read_notification(notification_id) + +Mark notification as read. + +Mark in-platform notification by its ID as read. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_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(configuration) as api_client: + # Create an instance of the API class + api_instance = notification_channels_api.NotificationChannelsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'notificationId': "notificationId_example", + } + try: + # Mark notification as read. + api_response = api_instance.mark_as_read_notification( + path_params=path_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->mark_as_read_notification: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +notificationId | NotificationIdSchema | | + +# NotificationIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#mark_as_read_notification.ApiResponseFor204) | No Content + +#### mark_as_read_notification.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **mark_as_read_notification_all** + +> mark_as_read_notification_all() + +Mark all notifications as read. + +Mark all user in-platform notifications as read. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_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(configuration) as api_client: + # Create an instance of the API class + api_instance = notification_channels_api.NotificationChannelsApi(api_client) + + # example passing only optional values + query_params = { + 'workspaceId': "workspaceId_example", + } + try: + # Mark all notifications as read. + api_response = api_instance.mark_as_read_notification_all( + query_params=query_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->mark_as_read_notification_all: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | optional + + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#mark_as_read_notification_all.ApiResponseFor204) | No Content + +#### mark_as_read_notification_all.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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(idjson_api_notification_channel_patch_document) + +Patch Notification Channel entity + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_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 pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = notification_channels_api.NotificationChannelsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + body = JsonApiNotificationChannelPatchDocument( + data=JsonApiNotificationChannelPatch( + attributes=dict( + allowed_recipients="CREATOR", + custom_dashboard_url="custom_dashboard_url_example", + dashboard_link_visibility="HIDDEN", + description="description_example", + destination=None, + in_platform_notification="DISABLED", + name="name_example", + notification_source="notification_source_example", + ), + id="id1", + type="notificationChannel", + ), + ) + try: + # Patch Notification Channel entity + api_response = api_instance.patch_entity_notification_channels( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->patch_entity_notification_channels: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;description==someString", + } + body = JsonApiNotificationChannelPatchDocument( + data=JsonApiNotificationChannelPatch( + attributes=dict( + allowed_recipients="CREATOR", + custom_dashboard_url="custom_dashboard_url_example", + dashboard_link_visibility="HIDDEN", + description="description_example", + destination=None, + in_platform_notification="DISABLED", + name="name_example", + notification_source="notification_source_example", + ), + id="id1", + type="notificationChannel", + ), + ) + try: + # Patch Notification Channel entity + api_response = api_instance.patch_entity_notification_channels( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->patch_entity_notification_channels: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelPatchDocument**](../../models/JsonApiNotificationChannelPatchDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelPatchDocument**](../../models/JsonApiNotificationChannelPatchDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#patch_entity_notification_channels.ApiResponseFor200) | Request successfully processed + +#### patch_entity_notification_channels.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelOutDocument**](../../models/JsonApiNotificationChannelOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelOutDocument**](../../models/JsonApiNotificationChannelOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **set_export_templates** + +> set_export_templates(declarative_export_templates) + +Set all export templates + +Sets export templates in organization. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_api +from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = notification_channels_api.NotificationChannelsApi(api_client) + + # example passing only required values which don't have defaults set + body = DeclarativeExportTemplates( + export_templates=[ + DeclarativeExportTemplate( + dashboard_slides_template=DashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), +, + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection(), + header=RunningSection(), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field="About:\n{{dashboardDescription}}\n\n{{dashboardFilters}}", + footer=RunningSection(), + header=RunningSection(), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection(), + header=RunningSection(), + ), + ), + id="default-export-template", + name="My default export template", + widget_slides_template=WidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate(), + ), + ) + ], + ) + try: + # Set all export templates + api_response = api_instance.set_export_templates( + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->set_export_templates: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**DeclarativeExportTemplates**](../../models/DeclarativeExportTemplates.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#set_export_templates.ApiResponseFor204) | All export templates set. + +#### set_export_templates.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **set_notification_channels** + +> set_notification_channels(declarative_notification_channels) + +Set all notification channels + +Sets notification channels in organization. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_api +from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = notification_channels_api.NotificationChannelsApi(api_client) + + # example passing only required values which don't have defaults set + body = DeclarativeNotificationChannels( + notification_channels=[ + DeclarativeNotificationChannel( + allowed_recipients="INTERNAL", + custom_dashboard_url="custom_dashboard_url_example", + dashboard_link_visibility="INTERNAL_ONLY", + description="This is a channel", + destination=None, + destination_type="WEBHOOK", + id="notification-channel-1", + in_platform_notification="DISABLED", + name="channel", + notification_source="notification_source_example", + ) + ], + ) + try: + # Set all notification channels + api_response = api_instance.set_notification_channels( + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->set_notification_channels: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**DeclarativeNotificationChannels**](../../models/DeclarativeNotificationChannels.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#set_notification_channels.ApiResponseFor204) | All notification channels set. + +#### set_notification_channels.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **test_existing_notification_channel** + +> TestResponse test_existing_notification_channel(notification_channel_id) + +Test existing notification channel. + +Tests the existing notification channel by sending a test notification. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_api +from gooddata_api_client.model.test_response import TestResponse +from gooddata_api_client.model.test_destination_request import TestDestinationRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = notification_channels_api.NotificationChannelsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'notificationChannelId': "notificationChannelId_example", + } + try: + # Test existing notification channel. + api_response = api_instance.test_existing_notification_channel( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->test_existing_notification_channel: %s\n" % e) + + # example passing only optional values + path_params = { + 'notificationChannelId': "notificationChannelId_example", + } + body = TestDestinationRequest( + destination=None, + external_recipients=[ + AutomationExternalRecipient( + email="email_example", + ) + ], + ) + try: + # Test existing notification channel. + api_response = api_instance.test_existing_notification_channel( + path_params=path_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->test_existing_notification_channel: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, Unset] | optional, default is unset | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**TestDestinationRequest**](../../models/TestDestinationRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +notificationChannelId | NotificationChannelIdSchema | | + +# NotificationChannelIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#test_existing_notification_channel.ApiResponseFor200) | The result of the test of a notification channel connection. + +#### test_existing_notification_channel.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**TestResponse**](../../models/TestResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **test_notification_channel** + +> TestResponse test_notification_channel(test_destination_request) + +Test notification channel. + +Tests the notification channel by sending a test notification. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_api +from gooddata_api_client.model.test_response import TestResponse +from gooddata_api_client.model.test_destination_request import TestDestinationRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = notification_channels_api.NotificationChannelsApi(api_client) + + # example passing only required values which don't have defaults set + body = TestDestinationRequest( + destination=None, + external_recipients=[ + AutomationExternalRecipient( + email="email_example", + ) + ], + ) + try: + # Test notification channel. + api_response = api_instance.test_notification_channel( + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->test_notification_channel: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**TestDestinationRequest**](../../models/TestDestinationRequest.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#test_notification_channel.ApiResponseFor200) | The result of the test of a notification channel connection. + +#### test_notification_channel.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**TestResponse**](../../models/TestResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_notification_channels** + +> JsonApiNotificationChannelOutDocument update_entity_notification_channels(idjson_api_notification_channel_in_document) + +Put Notification Channel entity + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import notification_channels_api +from gooddata_api_client.model.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = notification_channels_api.NotificationChannelsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + body = JsonApiNotificationChannelInDocument( + data=JsonApiNotificationChannelIn( + attributes=dict( + allowed_recipients="CREATOR", + custom_dashboard_url="custom_dashboard_url_example", + dashboard_link_visibility="HIDDEN", + description="description_example", + destination=None, + in_platform_notification="DISABLED", + name="name_example", + notification_source="notification_source_example", + ), + id="id1", + type="notificationChannel", + ), + ) + try: + # Put Notification Channel entity + api_response = api_instance.update_entity_notification_channels( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->update_entity_notification_channels: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "name==someString;description==someString", + } + body = JsonApiNotificationChannelInDocument( + data=JsonApiNotificationChannelIn( + attributes=dict( + allowed_recipients="CREATOR", + custom_dashboard_url="custom_dashboard_url_example", + dashboard_link_visibility="HIDDEN", + description="description_example", + destination=None, + in_platform_notification="DISABLED", + name="name_example", + notification_source="notification_source_example", + ), + id="id1", + type="notificationChannel", + ), + ) + try: + # Put Notification Channel entity + api_response = api_instance.update_entity_notification_channels( + path_params=path_params, + query_params=query_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling NotificationChannelsApi->update_entity_notification_channels: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, SchemaForRequestBodyApplicationVndGooddataApijson] | required | +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelInDocument**](../../models/JsonApiNotificationChannelInDocument.md) | | + + +# SchemaForRequestBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelInDocument**](../../models/JsonApiNotificationChannelInDocument.md) | | + + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#update_entity_notification_channels.ApiResponseFor200) | Request successfully processed + +#### update_entity_notification_channels.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelOutDocument**](../../models/JsonApiNotificationChannelOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiNotificationChannelOutDocument**](../../models/JsonApiNotificationChannelOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/OrganizationApi.md b/gooddata-api-client/docs/apis/tags/OrganizationApi.md new file mode 100644 index 000000000..c3dab4b55 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/OrganizationApi.md @@ -0,0 +1,85 @@ + +# gooddata_api_client.apis.tags.organization_api.OrganizationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**switch_active_identity_provider**](#switch_active_identity_provider) | **post** /api/v1/actions/organization/switchActiveIdentityProvider | Switch Active Identity Provider + +# **switch_active_identity_provider** + +> switch_active_identity_provider(switch_identity_provider_request) + +Switch Active Identity Provider + +Switch the active identity provider for the organization. Requires MANAGE permission on the organization. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import organization_api +from gooddata_api_client.model.switch_identity_provider_request import SwitchIdentityProviderRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = organization_api.OrganizationApi(api_client) + + # example passing only required values which don't have defaults set + body = SwitchIdentityProviderRequest( + idp_id="my-idp-123", + ) + try: + # Switch Active Identity Provider + api_response = api_instance.switch_active_identity_provider( + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrganizationApi->switch_active_identity_provider: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**SwitchIdentityProviderRequest**](../../models/SwitchIdentityProviderRequest.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#switch_active_identity_provider.ApiResponseFor204) | No Content + +#### switch_active_identity_provider.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/RawExportApi.md b/gooddata-api-client/docs/apis/tags/RawExportApi.md new file mode 100644 index 000000000..f4a42a14d --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/RawExportApi.md @@ -0,0 +1,327 @@ + +# gooddata_api_client.apis.tags.raw_export_api.RawExportApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_raw_export**](#create_raw_export) | **post** /api/v1/actions/workspaces/{workspaceId}/export/raw | (EXPERIMENTAL) Create raw export request +[**get_raw_export**](#get_raw_export) | **get** /api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId} | (EXPERIMENTAL) Retrieve exported files + +# **create_raw_export** + +> ExportResponse create_raw_export(workspace_idraw_export_request) + +(EXPERIMENTAL) Create raw export request + +Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import raw_export_api +from gooddata_api_client.model.export_response import ExportResponse +from gooddata_api_client.model.raw_export_request import RawExportRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = raw_export_api.RawExportApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = RawExportRequest( + custom_override=RawCustomOverride( + labels=dict( + "key": RawCustomLabel( + title="title_example", + ), + ), + metrics=dict( + "key": RawCustomMetric( + title="title_example", + ), + ), + ), + delimiter="U", + execution=AFM( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=dict( + id="sample_item.price", + type="label", + ), + ), + local_identifier="attribute_1", + show_all_values=False, + ) + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ) + ], + filters=[ + FilterDefinition() + ], + measure_definition_overrides=[ + MetricDefinitionOverride( + definition=InlineMeasureDefinition( + inline=dict( + maql="maql_example", + ), + ), + item=AfmObjectIdentifierCore( + identifier=dict( + id="sample_item.price", + type="attribute", + ), + ), + ) + ], + measures=[ + MeasureItem() + ], + ), + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp="1970-01-01T00:00:00.00Z", + ), + file_name="result", + format="CSV", + ) + try: + # (EXPERIMENTAL) Create raw export request + api_response = api_instance.create_raw_export( + path_params=path_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling RawExportApi->create_raw_export: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**RawExportRequest**](../../models/RawExportRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_raw_export.ApiResponseFor201) | Raw export request created successfully. + +#### create_raw_export.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ExportResponse**](../../models/ExportResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_raw_export** + +> file_type get_raw_export(workspace_idexport_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 gooddata_api_client +from gooddata_api_client.apis.tags import raw_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(configuration) as api_client: + # Create an instance of the API class + api_instance = raw_export_api.RawExportApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'exportId': "exportId_example", + } + try: + # (EXPERIMENTAL) Retrieve exported files + api_response = api_instance.get_raw_export( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling RawExportApi->get_raw_export: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/vnd.apache.arrow.file', 'application/vnd.apache.arrow.stream', 'text/csv', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +exportId | ExportIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ExportIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_raw_export.ApiResponseFor200) | Binary export result. +202 | [ApiResponseFor202](#get_raw_export.ApiResponseFor202) | Request is accepted, provided exportId exists, but export is not yet ready. + +#### get_raw_export.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationVndApacheArrowFile, SchemaFor200ResponseBodyApplicationVndApacheArrowStream, SchemaFor200ResponseBodyTextCsv, ] | | +headers | ResponseHeadersFor200 | | + +# SchemaFor200ResponseBodyApplicationVndApacheArrowFile + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +# SchemaFor200ResponseBodyApplicationVndApacheArrowStream + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +# SchemaFor200ResponseBodyTextCsv + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | +#### ResponseHeadersFor200 + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +Content-Disposition | ContentDispositionSchema | | optional + +# ContentDispositionSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + + +#### get_raw_export.ApiResponseFor202 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor202ResponseBodyApplicationVndApacheArrowFile, SchemaFor202ResponseBodyApplicationVndApacheArrowStream, SchemaFor202ResponseBodyTextCsv, ] | | +headers | Unset | headers were not defined | + +# SchemaFor202ResponseBodyApplicationVndApacheArrowFile + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +# SchemaFor202ResponseBodyApplicationVndApacheArrowStream + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +# SchemaFor202ResponseBodyTextCsv + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/SlidesExportApi.md b/gooddata-api-client/docs/apis/tags/SlidesExportApi.md new file mode 100644 index 000000000..007992710 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/SlidesExportApi.md @@ -0,0 +1,461 @@ + +# gooddata_api_client.apis.tags.slides_export_api.SlidesExportApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_slides_export**](#create_slides_export) | **post** /api/v1/actions/workspaces/{workspaceId}/export/slides | (EXPERIMENTAL) Create slides export request +[**get_slides_export**](#get_slides_export) | **get** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId} | (EXPERIMENTAL) Retrieve exported files +[**get_slides_export_metadata**](#get_slides_export_metadata) | **get** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context + +# **create_slides_export** + +> ExportResponse create_slides_export(workspace_idslides_export_request) + +(EXPERIMENTAL) Create slides 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. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import slides_export_api +from gooddata_api_client.model.export_response import ExportResponse +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = slides_export_api.SlidesExportApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + header_params = { + } + body = SlidesExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + template_id="template_id_example", + visualization_ids=[ + "visualization_ids_example" + ], + widget_ids=[ + "widget_ids_example" + ], + ) + try: + # (EXPERIMENTAL) Create slides export request + api_response = api_instance.create_slides_export( + path_params=path_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SlidesExportApi->create_slides_export: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + header_params = { + 'X-Gdc-Debug': False, + } + body = SlidesExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + template_id="template_id_example", + visualization_ids=[ + "visualization_ids_example" + ], + widget_ids=[ + "widget_ids_example" + ], + ) + try: + # (EXPERIMENTAL) Create slides export request + api_response = api_instance.create_slides_export( + path_params=path_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SlidesExportApi->create_slides_export: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**SlidesExportRequest**](../../models/SlidesExportRequest.md) | | + + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-Gdc-Debug | XGdcDebugSchema | | optional + +# XGdcDebugSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_slides_export.ApiResponseFor201) | Slides export request created successfully. + +#### create_slides_export.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ExportResponse**](../../models/ExportResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idexport_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 gooddata_api_client +from gooddata_api_client.apis.tags import slides_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(configuration) as api_client: + # Create an instance of the API class + api_instance = slides_export_api.SlidesExportApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'exportId': "exportId_example", + } + try: + # (EXPERIMENTAL) Retrieve exported files + api_response = api_instance.get_slides_export( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SlidesExportApi->get_slides_export: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/pdf', 'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'application/zip', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +exportId | ExportIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ExportIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_slides_export.ApiResponseFor200) | Binary export result. +202 | [ApiResponseFor202](#get_slides_export.ApiResponseFor202) | Request is accepted, provided exportId exists, but export is not yet ready. + +#### get_slides_export.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationPdf, SchemaFor200ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation, SchemaFor200ResponseBodyApplicationZip, ] | | +headers | ResponseHeadersFor200 | | + +# SchemaFor200ResponseBodyApplicationPdf + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +# SchemaFor200ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +# SchemaFor200ResponseBodyApplicationZip + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | +#### ResponseHeadersFor200 + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +Content-Disposition | ContentDispositionSchema | | optional + +# ContentDispositionSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + + +#### get_slides_export.ApiResponseFor202 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor202ResponseBodyApplicationPdf, SchemaFor202ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation, ] | | +headers | Unset | headers were not defined | + +# SchemaFor202ResponseBodyApplicationPdf + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**char** | str, | str, | | [optional] +**direct** | bool, | BoolClass, | | [optional] +**double** | decimal.Decimal, int, float, | decimal.Decimal, | | [optional] value must be a 64 bit float +**float** | decimal.Decimal, int, float, | decimal.Decimal, | | [optional] value must be a 32 bit float +**int** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer +**long** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 64 bit integer +**readOnly** | bool, | BoolClass, | | [optional] +**short** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# SchemaFor202ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**char** | str, | str, | | [optional] +**direct** | bool, | BoolClass, | | [optional] +**double** | decimal.Decimal, int, float, | decimal.Decimal, | | [optional] value must be a 64 bit float +**float** | decimal.Decimal, int, float, | decimal.Decimal, | | [optional] value must be a 32 bit float +**int** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer +**long** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 64 bit integer +**readOnly** | bool, | BoolClass, | | [optional] +**short** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idexport_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. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import slides_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(configuration) as api_client: + # Create an instance of the API class + api_instance = slides_export_api.SlidesExportApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'exportId': "exportId_example", + } + try: + # (EXPERIMENTAL) Retrieve metadata context + api_response = api_instance.get_slides_export_metadata( + path_params=path_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling SlidesExportApi->get_slides_export_metadata: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +exportId | ExportIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ExportIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_slides_export_metadata.ApiResponseFor200) | Json metadata representation + +#### get_slides_export_metadata.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[Unset, ] | | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/SmartFunctionsApi.md b/gooddata-api-client/docs/apis/tags/SmartFunctionsApi.md new file mode 100644 index 000000000..7d276bf86 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/SmartFunctionsApi.md @@ -0,0 +1,2759 @@ + +# gooddata_api_client.apis.tags.smart_functions_api.SmartFunctionsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**ai_chat**](#ai_chat) | **post** /api/v1/actions/workspaces/{workspaceId}/ai/chat | (BETA) Chat with AI +[**ai_chat_history**](#ai_chat_history) | **post** /api/v1/actions/workspaces/{workspaceId}/ai/chatHistory | (BETA) Get Chat History +[**ai_chat_stream**](#ai_chat_stream) | **post** /api/v1/actions/workspaces/{workspaceId}/ai/chatStream | (BETA) Chat with AI +[**ai_chat_usage**](#ai_chat_usage) | **get** /api/v1/actions/workspaces/{workspaceId}/ai/chatUsage | Get Chat Usage +[**ai_search**](#ai_search) | **post** /api/v1/actions/workspaces/{workspaceId}/ai/search | (BETA) Semantic Search in Metadata +[**anomaly_detection**](#anomaly_detection) | **post** /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId} | (EXPERIMENTAL) Smart functions - Anomaly Detection +[**anomaly_detection_result**](#anomaly_detection_result) | **get** /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId} | (EXPERIMENTAL) Smart functions - Anomaly Detection Result +[**clustering**](#clustering) | **post** /api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId} | (EXPERIMENTAL) Smart functions - Clustering +[**clustering_result**](#clustering_result) | **get** /api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/result/{resultId} | (EXPERIMENTAL) Smart functions - Clustering Result +[**created_by**](#created_by) | **get** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy | Get Analytics Catalog CreatedBy Users +[**forecast**](#forecast) | **post** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | (BETA) Smart functions - Forecast +[**forecast_result**](#forecast_result) | **get** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | (BETA) Smart functions - Forecast Result +[**generate_description**](#generate_description) | **post** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateDescription | Generate Description for Analytics Object +[**generate_title**](#generate_title) | **post** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateTitle | Generate Title for Analytics Object +[**get_quality_issues**](#get_quality_issues) | **get** /api/v1/actions/workspaces/{workspaceId}/ai/issues | Get Quality Issues +[**get_quality_issues_calculation_status**](#get_quality_issues_calculation_status) | **get** /api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId} | Get Quality Issues Calculation Status +[**memory_created_by_users**](#memory_created_by_users) | **get** /api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy | Get AI Memory CreatedBy Users +[**resolve_llm_endpoints**](#resolve_llm_endpoints) | **get** /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints | Get Active LLM Endpoints for this workspace +[**tags**](#tags) | **get** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags | Get Analytics Catalog Tags +[**test_llm_provider**](#test_llm_provider) | **post** /api/v1/actions/ai/llmProvider/test | Test LLM Provider +[**test_llm_provider_by_id**](#test_llm_provider_by_id) | **post** /api/v1/actions/ai/llmProvider/{llmProviderId}/test | Test LLM Provider By Id +[**trigger_quality_issues_calculation**](#trigger_quality_issues_calculation) | **post** /api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck | Trigger Quality Issues Calculation +[**validate_llm_endpoint**](#validate_llm_endpoint) | **post** /api/v1/actions/ai/llmEndpoint/test | Validate LLM Endpoint +[**validate_llm_endpoint_by_id**](#validate_llm_endpoint_by_id) | **post** /api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test | Validate LLM Endpoint By Id + +# **ai_chat** + +> ChatResult ai_chat(workspace_idchat_request) + +(BETA) Chat with AI + +(BETA) Combines multiple use cases such as search, create visualizations, ... + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags 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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + } + body = 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", + ), + ), + ) + try: + # (BETA) Chat with AI + api_response = api_instance.ai_chat( + path_params=path_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->ai_chat: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ChatRequest**](../../models/ChatRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#ai_chat.ApiResponseFor200) | OK + +#### ai_chat.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ChatResult**](../../models/ChatResult.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idchat_history_request) + +(BETA) Get Chat History + +(BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags 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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + } + body = 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", + ) + try: + # (BETA) Get Chat History + api_response = api_instance.ai_chat_history( + path_params=path_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->ai_chat_history: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ChatHistoryRequest**](../../models/ChatHistoryRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#ai_chat_history.ApiResponseFor200) | OK + +#### ai_chat_history.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ChatHistoryResult**](../../models/ChatHistoryResult.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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** + +> [object] ai_chat_stream(workspace_idchat_request) + +(BETA) Chat with AI + +(BETA) Combines multiple use cases such as search, create visualizations, ... + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags 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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + } + body = 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", + ), + ), + ) + try: + # (BETA) Chat with AI + api_response = api_instance.ai_chat_stream( + path_params=path_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->ai_chat_stream: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('text/event-stream', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ChatRequest**](../../models/ChatRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#ai_chat_stream.ApiResponseFor200) | OK + +#### ai_chat_stream.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyTextEventStream, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyTextEventStream + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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) + +Get Chat Usage + +Returns usage statistics of chat for a user in a workspace. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags 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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + } + try: + # Get Chat Usage + api_response = api_instance.ai_chat_usage( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->ai_chat_usage: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#ai_chat_usage.ApiResponseFor200) | OK + +#### ai_chat_usage.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ChatUsageResponse**](../../models/ChatUsageResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idsearch_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 gooddata_api_client +from gooddata_api_client.apis.tags 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(configuration) as api_client: + # Create an instance of the API class + api_instance = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + } + body = 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, + ) + try: + # (BETA) Semantic Search in Metadata + api_response = api_instance.ai_search( + path_params=path_params, + body=body, + ) + 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 +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**SearchRequest**](../../models/SearchRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#ai_search.ApiResponseFor200) | OK + +#### ai_search.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**SearchResult**](../../models/SearchResult.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **anomaly_detection** + +> SmartFunctionResponse anomaly_detection(workspace_idresult_idanomaly_detection_request) + +(EXPERIMENTAL) Smart functions - Anomaly Detection + +(EXPERIMENTAL) Computes anomaly detection. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.anomaly_detection_request import AnomalyDetectionRequest +from gooddata_api_client.model.smart_function_response import SmartFunctionResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + 'resultId': "9bd52018570364264fcf62d373da6bed313120e8", + } + header_params = { + } + body = AnomalyDetectionRequest( + sensitivity=3.14, + ) + try: + # (EXPERIMENTAL) Smart functions - Anomaly Detection + api_response = api_instance.anomaly_detection( + path_params=path_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->anomaly_detection: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + 'resultId': "9bd52018570364264fcf62d373da6bed313120e8", + } + header_params = { + 'skip-cache': False, + } + body = AnomalyDetectionRequest( + sensitivity=3.14, + ) + try: + # (EXPERIMENTAL) Smart functions - Anomaly Detection + api_response = api_instance.anomaly_detection( + path_params=path_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->anomaly_detection: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**AnomalyDetectionRequest**](../../models/AnomalyDetectionRequest.md) | | + + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +skip-cache | SkipCacheSchema | | optional + +# SkipCacheSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +resultId | ResultIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ResultIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#anomaly_detection.ApiResponseFor200) | OK + +#### anomaly_detection.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**SmartFunctionResponse**](../../models/SmartFunctionResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **anomaly_detection_result** + +> AnomalyDetectionResult anomaly_detection_result(workspace_idresult_id) + +(EXPERIMENTAL) Smart functions - Anomaly Detection Result + +(EXPERIMENTAL) Gets anomalies. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.anomaly_detection_result import AnomalyDetectionResult +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + 'resultId': "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + } + query_params = { + } + try: + # (EXPERIMENTAL) Smart functions - Anomaly Detection Result + api_response = api_instance.anomaly_detection_result( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->anomaly_detection_result: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + 'resultId': "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + } + query_params = { + 'offset': 1, + 'limit': 1, + } + try: + # (EXPERIMENTAL) Smart functions - Anomaly Detection Result + api_response = api_instance.anomaly_detection_result( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->anomaly_detection_result: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +offset | OffsetSchema | | optional +limit | LimitSchema | | optional + + +# OffsetSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +# LimitSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +resultId | ResultIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ResultIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#anomaly_detection_result.ApiResponseFor200) | OK + +#### anomaly_detection_result.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**AnomalyDetectionResult**](../../models/AnomalyDetectionResult.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **clustering** + +> SmartFunctionResponse clustering(workspace_idresult_idclustering_request) + +(EXPERIMENTAL) Smart functions - Clustering + +(EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.clustering_request import ClusteringRequest +from gooddata_api_client.model.smart_function_response import SmartFunctionResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + 'resultId': "9bd52018570364264fcf62d373da6bed313120e8", + } + header_params = { + } + body = ClusteringRequest( + number_of_clusters=1, + threshold=0.03, + ) + try: + # (EXPERIMENTAL) Smart functions - Clustering + api_response = api_instance.clustering( + path_params=path_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->clustering: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + 'resultId': "9bd52018570364264fcf62d373da6bed313120e8", + } + header_params = { + 'skip-cache': False, + } + body = ClusteringRequest( + number_of_clusters=1, + threshold=0.03, + ) + try: + # (EXPERIMENTAL) Smart functions - Clustering + api_response = api_instance.clustering( + path_params=path_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->clustering: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ClusteringRequest**](../../models/ClusteringRequest.md) | | + + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +skip-cache | SkipCacheSchema | | optional + +# SkipCacheSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +resultId | ResultIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ResultIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#clustering.ApiResponseFor200) | OK + +#### clustering.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**SmartFunctionResponse**](../../models/SmartFunctionResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **clustering_result** + +> ClusteringResult clustering_result(workspace_idresult_id) + +(EXPERIMENTAL) Smart functions - Clustering Result + +(EXPERIMENTAL) Gets clustering result. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.clustering_result import ClusteringResult +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + 'resultId': "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + } + query_params = { + } + try: + # (EXPERIMENTAL) Smart functions - Clustering Result + api_response = api_instance.clustering_result( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->clustering_result: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + 'resultId': "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + } + query_params = { + 'offset': 1, + 'limit': 1, + } + try: + # (EXPERIMENTAL) Smart functions - Clustering Result + api_response = api_instance.clustering_result( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->clustering_result: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +offset | OffsetSchema | | optional +limit | LimitSchema | | optional + + +# OffsetSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +# LimitSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +resultId | ResultIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ResultIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#clustering_result.ApiResponseFor200) | OK + +#### clustering_result.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ClusteringResult**](../../models/ClusteringResult.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **created_by** + +> AnalyticsCatalogCreatedBy created_by(workspace_id) + +Get Analytics Catalog CreatedBy Users + +Returns a list of Users who created any object for this workspace + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.analytics_catalog_created_by import AnalyticsCatalogCreatedBy +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + } + try: + # Get Analytics Catalog CreatedBy Users + api_response = api_instance.created_by( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->created_by: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#created_by.ApiResponseFor200) | OK + +#### created_by.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**AnalyticsCatalogCreatedBy**](../../models/AnalyticsCatalogCreatedBy.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **forecast** + +> SmartFunctionResponse forecast(workspace_idresult_idforecast_request) + +(BETA) Smart functions - Forecast + +(BETA) Computes forecasted data points from the provided execution result and parameters. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.forecast_request import ForecastRequest +from gooddata_api_client.model.smart_function_response import SmartFunctionResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + 'resultId': "9bd52018570364264fcf62d373da6bed313120e8", + } + header_params = { + } + body = ForecastRequest( + confidence_level=0.95, + forecast_period=1, + seasonal=False, + ) + try: + # (BETA) Smart functions - Forecast + api_response = api_instance.forecast( + path_params=path_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->forecast: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + 'resultId': "9bd52018570364264fcf62d373da6bed313120e8", + } + header_params = { + 'skip-cache': False, + } + body = ForecastRequest( + confidence_level=0.95, + forecast_period=1, + seasonal=False, + ) + try: + # (BETA) Smart functions - Forecast + api_response = api_instance.forecast( + path_params=path_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->forecast: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ForecastRequest**](../../models/ForecastRequest.md) | | + + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +skip-cache | SkipCacheSchema | | optional + +# SkipCacheSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +resultId | ResultIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ResultIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#forecast.ApiResponseFor200) | OK + +#### forecast.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**SmartFunctionResponse**](../../models/SmartFunctionResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **forecast_result** + +> ForecastResult forecast_result(workspace_idresult_id) + +(BETA) Smart functions - Forecast Result + +(BETA) Gets forecast result. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.forecast_result import ForecastResult +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + 'resultId': "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + } + query_params = { + } + try: + # (BETA) Smart functions - Forecast Result + api_response = api_instance.forecast_result( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->forecast_result: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + 'resultId': "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + } + query_params = { + 'offset': 1, + 'limit': 1, + } + try: + # (BETA) Smart functions - Forecast Result + api_response = api_instance.forecast_result( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->forecast_result: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +offset | OffsetSchema | | optional +limit | LimitSchema | | optional + + +# OffsetSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +# LimitSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +resultId | ResultIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ResultIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#forecast_result.ApiResponseFor200) | OK + +#### forecast_result.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ForecastResult**](../../models/ForecastResult.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_description** + +> GenerateDescriptionResponse generate_description(workspace_idgenerate_description_request) + +Generate Description for Analytics Object + +Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.generate_description_request import GenerateDescriptionRequest +from gooddata_api_client.model.generate_description_response import GenerateDescriptionResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + } + body = GenerateDescriptionRequest( + object_id="object_id_example", + object_type="Visualization", + ) + try: + # Generate Description for Analytics Object + api_response = api_instance.generate_description( + path_params=path_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->generate_description: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**GenerateDescriptionRequest**](../../models/GenerateDescriptionRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#generate_description.ApiResponseFor200) | OK + +#### generate_description.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**GenerateDescriptionResponse**](../../models/GenerateDescriptionResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_title** + +> GenerateTitleResponse generate_title(workspace_idgenerate_title_request) + +Generate Title for Analytics Object + +Generates a title for the specified analytics object. Returns title and a note with details if generation was not performed. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.generate_title_request import GenerateTitleRequest +from gooddata_api_client.model.generate_title_response import GenerateTitleResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + } + body = GenerateTitleRequest( + object_id="object_id_example", + object_type="Visualization", + ) + try: + # Generate Title for Analytics Object + api_response = api_instance.generate_title( + path_params=path_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->generate_title: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**GenerateTitleRequest**](../../models/GenerateTitleRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#generate_title.ApiResponseFor200) | OK + +#### generate_title.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**GenerateTitleResponse**](../../models/GenerateTitleResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_quality_issues** + +> GetQualityIssuesResponse get_quality_issues(workspace_id) + +Get Quality Issues + +Returns metadata quality issues detected by the platform linter. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + } + try: + # Get Quality Issues + api_response = api_instance.get_quality_issues( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->get_quality_issues: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_quality_issues.ApiResponseFor200) | OK + +#### get_quality_issues.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**GetQualityIssuesResponse**](../../models/GetQualityIssuesResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_quality_issues_calculation_status** + +> QualityIssuesCalculationStatusResponse get_quality_issues_calculation_status(workspace_idprocess_id) + +Get Quality Issues Calculation Status + +Returns the status of a quality issues calculation process identified by process ID. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.quality_issues_calculation_status_response import QualityIssuesCalculationStatusResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + 'processId': "processId_example", + } + try: + # Get Quality Issues Calculation Status + api_response = api_instance.get_quality_issues_calculation_status( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->get_quality_issues_calculation_status: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +processId | ProcessIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ProcessIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_quality_issues_calculation_status.ApiResponseFor200) | OK + +#### get_quality_issues_calculation_status.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**QualityIssuesCalculationStatusResponse**](../../models/QualityIssuesCalculationStatusResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **memory_created_by_users** + +> MemoryItemCreatedByUsers memory_created_by_users(workspace_id) + +Get AI Memory CreatedBy Users + +Returns a list of Users who created any memory item for this workspace + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.memory_item_created_by_users import MemoryItemCreatedByUsers +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + } + try: + # Get AI Memory CreatedBy Users + api_response = api_instance.memory_created_by_users( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->memory_created_by_users: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#memory_created_by_users.ApiResponseFor200) | OK + +#### memory_created_by_users.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**MemoryItemCreatedByUsers**](../../models/MemoryItemCreatedByUsers.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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** + +> ResolvedLlmEndpoints resolve_llm_endpoints(workspace_id) + +Get Active LLM Endpoints for this workspace + +Returns a list of available LLM Endpoints + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.resolved_llm_endpoints import ResolvedLlmEndpoints +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + } + try: + # Get Active LLM Endpoints for this workspace + api_response = api_instance.resolve_llm_endpoints( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->resolve_llm_endpoints: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#resolve_llm_endpoints.ApiResponseFor200) | OK + +#### resolve_llm_endpoints.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ResolvedLlmEndpoints**](../../models/ResolvedLlmEndpoints.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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) + +Get Analytics Catalog Tags + +Returns a list of tags for this workspace + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.analytics_catalog_tags import AnalyticsCatalogTags +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + } + try: + # Get Analytics Catalog Tags + api_response = api_instance.tags( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->tags: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#tags.ApiResponseFor200) | OK + +#### tags.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**AnalyticsCatalogTags**](../../models/AnalyticsCatalogTags.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **test_llm_provider** + +> TestLlmProviderResponse test_llm_provider(test_llm_provider_definition_request) + +Test LLM Provider + +Tests LLM provider connectivity with a full definition. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse +from gooddata_api_client.model.test_llm_provider_definition_request import TestLlmProviderDefinitionRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + body = TestLlmProviderDefinitionRequest( + models=[ + LlmModel( + family="OPENAI", + id="id_example", + ) + ], + provider_config=None, + ) + try: + # Test LLM Provider + api_response = api_instance.test_llm_provider( + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->test_llm_provider: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**TestLlmProviderDefinitionRequest**](../../models/TestLlmProviderDefinitionRequest.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#test_llm_provider.ApiResponseFor200) | OK + +#### test_llm_provider.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**TestLlmProviderResponse**](../../models/TestLlmProviderResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **test_llm_provider_by_id** + +> TestLlmProviderResponse test_llm_provider_by_id(llm_provider_id) + +Test LLM Provider By Id + +Tests an existing LLM provider connectivity by its ID. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'llmProviderId': "llmProviderId_example", + } + try: + # Test LLM Provider By Id + api_response = api_instance.test_llm_provider_by_id( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->test_llm_provider_by_id: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +llmProviderId | LlmProviderIdSchema | | + +# LlmProviderIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#test_llm_provider_by_id.ApiResponseFor200) | OK + +#### test_llm_provider_by_id.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**TestLlmProviderResponse**](../../models/TestLlmProviderResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **trigger_quality_issues_calculation** + +> TriggerQualityIssuesCalculationResponse trigger_quality_issues_calculation(workspace_id) + +Trigger Quality Issues Calculation + +Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.trigger_quality_issues_calculation_response import TriggerQualityIssuesCalculationResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "/6bUUGjjNSwg0_bs", + } + try: + # Trigger Quality Issues Calculation + api_response = api_instance.trigger_quality_issues_calculation( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->trigger_quality_issues_calculation: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#trigger_quality_issues_calculation.ApiResponseFor200) | OK + +#### trigger_quality_issues_calculation.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**TriggerQualityIssuesCalculationResponse**](../../models/TriggerQualityIssuesCalculationResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **validate_llm_endpoint** + +> ValidateLLMEndpointResponse validate_llm_endpoint(validate_llm_endpoint_request) + +Validate LLM Endpoint + +Validates LLM endpoint with provided parameters. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse +from gooddata_api_client.model.validate_llm_endpoint_request import ValidateLLMEndpointRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + body = ValidateLLMEndpointRequest( + base_url="base_url_example", + llm_model="llm_model_example", + llm_organization="llm_organization_example", + provider="provider_example", + token="token_example", + ) + try: + # Validate LLM Endpoint + api_response = api_instance.validate_llm_endpoint( + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->validate_llm_endpoint: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ValidateLLMEndpointRequest**](../../models/ValidateLLMEndpointRequest.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#validate_llm_endpoint.ApiResponseFor200) | OK + +#### validate_llm_endpoint.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ValidateLLMEndpointResponse**](../../models/ValidateLLMEndpointResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **validate_llm_endpoint_by_id** + +> ValidateLLMEndpointResponse validate_llm_endpoint_by_id(llm_endpoint_id) + +Validate LLM Endpoint By Id + +Validates existing LLM endpoint with provided parameters and updates it if they are valid. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import smart_functions_api +from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse +from gooddata_api_client.model.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = smart_functions_api.SmartFunctionsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'llmEndpointId': "llmEndpointId_example", + } + try: + # Validate LLM Endpoint By Id + api_response = api_instance.validate_llm_endpoint_by_id( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->validate_llm_endpoint_by_id: %s\n" % e) + + # example passing only optional values + path_params = { + 'llmEndpointId': "llmEndpointId_example", + } + body = ValidateLLMEndpointByIdRequest( + base_url="base_url_example", + llm_model="llm_model_example", + llm_organization="llm_organization_example", + provider="provider_example", + token="token_example", + ) + try: + # Validate LLM Endpoint By Id + api_response = api_instance.validate_llm_endpoint_by_id( + path_params=path_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling SmartFunctionsApi->validate_llm_endpoint_by_id: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson, Unset] | optional, default is unset | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ValidateLLMEndpointByIdRequest**](../../models/ValidateLLMEndpointByIdRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +llmEndpointId | LlmEndpointIdSchema | | + +# LlmEndpointIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#validate_llm_endpoint_by_id.ApiResponseFor200) | OK + +#### validate_llm_endpoint_by_id.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ValidateLLMEndpointResponse**](../../models/ValidateLLMEndpointResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/TabularExportApi.md b/gooddata-api-client/docs/apis/tags/TabularExportApi.md new file mode 100644 index 000000000..bb8f3dfbb --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/TabularExportApi.md @@ -0,0 +1,461 @@ + +# gooddata_api_client.apis.tags.tabular_export_api.TabularExportApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_dashboard_export_request**](#create_dashboard_export_request) | **post** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular | (EXPERIMENTAL) Create dashboard tabular export request +[**create_tabular_export**](#create_tabular_export) | **post** /api/v1/actions/workspaces/{workspaceId}/export/tabular | Create tabular export request +[**get_tabular_export**](#get_tabular_export) | **get** /api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId} | Retrieve exported files + +# **create_dashboard_export_request** + +> ExportResponse create_dashboard_export_request(workspace_iddashboard_iddashboard_tabular_export_request) + +(EXPERIMENTAL) Create dashboard tabular export request + +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. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import tabular_export_api +from gooddata_api_client.model.export_response import ExportResponse +from gooddata_api_client.model.dashboard_tabular_export_request import DashboardTabularExportRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = tabular_export_api.TabularExportApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'dashboardId': "dashboardId_example", + } + body = DashboardTabularExportRequest( + dashboard_filters_override=[ + DashboardFilter() + ], + dashboard_tabs_filters_overrides=dict( + "key": [ + DashboardFilter() + ], + ), + file_name="result", + format="XLSX", + settings=DashboardExportSettings( + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + ), + widget_ids=[ + "widget_ids_example" + ], + ) + try: + # (EXPERIMENTAL) Create dashboard tabular export request + api_response = api_instance.create_dashboard_export_request( + path_params=path_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling TabularExportApi->create_dashboard_export_request: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**DashboardTabularExportRequest**](../../models/DashboardTabularExportRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +dashboardId | DashboardIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# DashboardIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_dashboard_export_request.ApiResponseFor201) | Tabular export request created successfully. + +#### create_dashboard_export_request.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ExportResponse**](../../models/ExportResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idtabular_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 gooddata_api_client +from gooddata_api_client.apis.tags import tabular_export_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(configuration) as api_client: + # Create an instance of the API class + api_instance = tabular_export_api.TabularExportApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = TabularExportRequest( + custom_override=CustomOverride( + labels=dict( + "key": CustomLabel( + title="title_example", + ), + ), + metrics=dict( + "key": CustomMetric( + format="format_example", + title="title_example", + ), + ), + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + file_name="result", + format="CSV", + metadata=JsonNode(), + related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + settings=Settings( + delimiter="U", + export_info=True, + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + pdf_page_size="a4 landscape", + pdf_table_style=[{"properties":[{"key":"font-size","value":"30px"}],"selector":"th"}], + pdf_top_left_content="Good", + pdf_top_right_content="Morning", + show_filters=False, + ), + visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", + visualization_object_custom_filters=[ + dict() + ], + ) + try: + # Create tabular export request + api_response = api_instance.create_tabular_export( + path_params=path_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling TabularExportApi->create_tabular_export: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**TabularExportRequest**](../../models/TabularExportRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_tabular_export.ApiResponseFor201) | Tabular export request created successfully. + +#### create_tabular_export.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ExportResponse**](../../models/ExportResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_idexport_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 + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import tabular_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(configuration) as api_client: + # Create an instance of the API class + api_instance = tabular_export_api.TabularExportApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'exportId': "exportId_example", + } + try: + # Retrieve exported files + api_response = api_instance.get_tabular_export( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling TabularExportApi->get_tabular_export: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/pdf', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/zip', 'text/csv', 'text/html', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +exportId | ExportIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ExportIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_tabular_export.ApiResponseFor200) | Binary export result. +202 | [ApiResponseFor202](#get_tabular_export.ApiResponseFor202) | Request is accepted, provided exportId exists, but export is not yet ready. + +#### get_tabular_export.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationPdf, SchemaFor200ResponseBodyApplicationVndOpenxmlformatsOfficedocumentSpreadsheetmlSheet, SchemaFor200ResponseBodyApplicationZip, SchemaFor200ResponseBodyTextCsv, SchemaFor200ResponseBodyTextHtml, ] | | +headers | ResponseHeadersFor200 | | + +# SchemaFor200ResponseBodyApplicationPdf + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +# SchemaFor200ResponseBodyApplicationVndOpenxmlformatsOfficedocumentSpreadsheetmlSheet + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +# SchemaFor200ResponseBodyApplicationZip + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +# SchemaFor200ResponseBodyTextCsv + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +# SchemaFor200ResponseBodyTextHtml + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | +#### ResponseHeadersFor200 + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +Content-Disposition | ContentDispositionSchema | | optional + +# ContentDispositionSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + + +#### get_tabular_export.ApiResponseFor202 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor202ResponseBodyApplicationPdf, SchemaFor202ResponseBodyApplicationVndOpenxmlformatsOfficedocumentSpreadsheetmlSheet, SchemaFor202ResponseBodyApplicationZip, SchemaFor202ResponseBodyTextCsv, SchemaFor202ResponseBodyTextHtml, ] | | +headers | Unset | headers were not defined | + +# SchemaFor202ResponseBodyApplicationPdf + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +# SchemaFor202ResponseBodyApplicationVndOpenxmlformatsOfficedocumentSpreadsheetmlSheet + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +# SchemaFor202ResponseBodyApplicationZip + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +# SchemaFor202ResponseBodyTextCsv + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +# SchemaFor202ResponseBodyTextHtml + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/TranslationsApi.md b/gooddata-api-client/docs/apis/tags/TranslationsApi.md new file mode 100644 index 000000000..59d3bdecf --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/TranslationsApi.md @@ -0,0 +1,438 @@ + +# gooddata_api_client.apis.tags.translations_api.TranslationsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**clean_translations**](#clean_translations) | **post** /api/v1/actions/workspaces/{workspaceId}/translations/clean | Cleans up translations. +[**get_translation_tags**](#get_translation_tags) | **get** /api/v1/actions/workspaces/{workspaceId}/translations | Get translation tags. +[**retrieve_translations**](#retrieve_translations) | **post** /api/v1/actions/workspaces/{workspaceId}/translations/retrieve | Retrieve translations for entities. +[**set_translations**](#set_translations) | **post** /api/v1/actions/workspaces/{workspaceId}/translations/set | Set translations for entities. + +# **clean_translations** + +> clean_translations(workspace_idlocale_request) + +Cleans up translations. + +Cleans up all translations for a particular locale. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import translations_api +from gooddata_api_client.model.locale_request import LocaleRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = translations_api.TranslationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = LocaleRequest( + locale="en-US", + ) + try: + # Cleans up translations. + api_response = api_instance.clean_translations( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling TranslationsApi->clean_translations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**LocaleRequest**](../../models/LocaleRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#clean_translations.ApiResponseFor204) | Translations were successfully removed. + +#### clean_translations.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 gooddata_api_client +from gooddata_api_client.apis.tags import translations_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(configuration) as api_client: + # Create an instance of the API class + api_instance = translations_api.TranslationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + try: + # Get translation tags. + api_response = api_instance.get_translation_tags( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling TranslationsApi->get_translation_tags: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_translation_tags.ApiResponseFor200) | Retrieved list of translation tags. + +#### get_translation_tags.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_translations** + +> Xliff retrieve_translations(workspace_idlocale_request) + +Retrieve translations for entities. + +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. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import translations_api +from gooddata_api_client.model.locale_request import LocaleRequest +from gooddata_api_client.model.xliff import Xliff +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = translations_api.TranslationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = LocaleRequest( + locale="en-US", + ) + try: + # Retrieve translations for entities. + api_response = api_instance.retrieve_translations( + path_params=path_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling TranslationsApi->retrieve_translations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/xml', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**LocaleRequest**](../../models/LocaleRequest.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#retrieve_translations.ApiResponseFor200) | XLIFF file containing translations for a particular locale. + +#### retrieve_translations.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationXml, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationXml +Type | Description | Notes +------------- | ------------- | ------------- +[**Xliff**](../../models/Xliff.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **set_translations** + +> set_translations(workspace_idxliff) + +Set translations for entities. + +Set translation for existing entities in a particular locale. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import translations_api +from gooddata_api_client.model.xliff import Xliff +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = translations_api.TranslationsApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + body = Xliff( + file=[ + File( + any=[ + dict() + ], + can_resegment="YES", + id="id_example", + notes=Notes( + note=[ + Note( + applies_to="SOURCE", + category="category_example", + content="content_example", + id="id_example", + other_attributes=dict( + "key": "key_example", + ), + priority=1, + ) + ], + ), + original="original_example", +, + skeleton=Skeleton( +, + href="href_example", + ), + space="space_example", + src_dir="LTR", + translate="YES", + trg_dir="LTR", +, + ) + ], + other_attributes=dict(), + space="space_example", + src_lang="src_lang_example", + trg_lang="trg_lang_example", + version="version_example", + ) + try: + # Set translations for entities. + api_response = api_instance.set_translations( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling TranslationsApi->set_translations: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationXml] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/xml' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationXml +Type | Description | Notes +------------- | ------------- | ------------- +[**Xliff**](../../models/Xliff.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#set_translations.ApiResponseFor204) | Translations were successfully set. + +#### set_translations.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/UserIdentifiersApi.md b/gooddata-api-client/docs/apis/tags/UserIdentifiersApi.md new file mode 100644 index 000000000..682ba68b9 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/UserIdentifiersApi.md @@ -0,0 +1,289 @@ + +# gooddata_api_client.apis.tags.user_identifiers_api.UserIdentifiersApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_all_entities_user_identifiers**](#get_all_entities_user_identifiers) | **get** /api/v1/entities/userIdentifiers | Get UserIdentifier entities +[**get_entity_user_identifiers**](#get_entity_user_identifiers) | **get** /api/v1/entities/userIdentifiers/{id} | Get UserIdentifier entity + +# **get_all_entities_user_identifiers** + +> JsonApiUserIdentifierOutList get_all_entities_user_identifiers() + +Get UserIdentifier entities + +UserIdentifier - represents entity interacting with platform + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import user_identifiers_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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = user_identifiers_api.UserIdentifiersApi(api_client) + + # example passing only optional values + query_params = { + 'filter': "firstname==someString;lastname==someString", + 'page': 0, + 'size': 20, + 'sort': [ + "sort_example" + ], + 'metaInclude': [ + "metaInclude=page,all" + ], + } + try: + # Get UserIdentifier entities + api_response = api_instance.get_all_entities_user_identifiers( + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserIdentifiersApi->get_all_entities_user_identifiers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional +page | PageSchema | | optional +size | SizeSchema | | optional +sort | SortSchema | | optional +metaInclude | MetaIncludeSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0 + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20 + +# SortSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# MetaIncludeSchema + +Included meta objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included meta objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["page", "all", "ALL", ] + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_all_entities_user_identifiers.ApiResponseFor200) | Request successfully processed + +#### get_all_entities_user_identifiers.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiUserIdentifierOutList**](../../models/JsonApiUserIdentifierOutList.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiUserIdentifierOutList**](../../models/JsonApiUserIdentifierOutList.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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 + +UserIdentifier - represents basic information about entity interacting with platform + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import user_identifiers_api +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. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = user_identifiers_api.UserIdentifiersApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + } + try: + # Get UserIdentifier entity + api_response = api_instance.get_entity_user_identifiers( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserIdentifiersApi->get_entity_user_identifiers: %s\n" % e) + + # example passing only optional values + path_params = { + 'id': "/6bUUGjjNSwg0_bs", + } + query_params = { + 'filter': "firstname==someString;lastname==someString", + } + try: + # Get UserIdentifier entity + api_response = api_instance.get_entity_user_identifiers( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserIdentifiersApi->get_entity_user_identifiers: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', 'application/vnd.gooddata.api+json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +filter | FilterSchema | | optional + + +# FilterSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | IdSchema | | + +# IdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_entity_user_identifiers.ApiResponseFor200) | Request successfully processed + +#### get_entity_user_identifiers.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, SchemaFor200ResponseBodyApplicationVndGooddataApijson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiUserIdentifierOutDocument**](../../models/JsonApiUserIdentifierOutDocument.md) | | + + +# SchemaFor200ResponseBodyApplicationVndGooddataApijson +Type | Description | Notes +------------- | ------------- | ------------- +[**JsonApiUserIdentifierOutDocument**](../../models/JsonApiUserIdentifierOutDocument.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/UserManagementApi.md b/gooddata-api-client/docs/apis/tags/UserManagementApi.md new file mode 100644 index 000000000..44d18bce1 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/UserManagementApi.md @@ -0,0 +1,1503 @@ + +# gooddata_api_client.apis.tags.user_management_api.UserManagementApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_group_members**](#add_group_members) | **post** /api/v1/actions/userManagement/userGroups/{userGroupId}/addMembers | +[**assign_permissions**](#assign_permissions) | **post** /api/v1/actions/userManagement/assignPermissions | +[**get_group_members**](#get_group_members) | **get** /api/v1/actions/userManagement/userGroups/{userGroupId}/members | +[**list_permissions_for_user**](#list_permissions_for_user) | **get** /api/v1/actions/userManagement/users/{userId}/permissions | +[**list_permissions_for_user_group**](#list_permissions_for_user_group) | **get** /api/v1/actions/userManagement/userGroups/{userGroupId}/permissions | +[**list_user_groups**](#list_user_groups) | **get** /api/v1/actions/userManagement/userGroups | +[**list_users**](#list_users) | **get** /api/v1/actions/userManagement/users | +[**list_workspace_user_groups**](#list_workspace_user_groups) | **get** /api/v1/actions/workspaces/{workspaceId}/userGroups | +[**list_workspace_users**](#list_workspace_users) | **get** /api/v1/actions/workspaces/{workspaceId}/users | +[**manage_permissions_for_user**](#manage_permissions_for_user) | **post** /api/v1/actions/userManagement/users/{userId}/permissions | +[**manage_permissions_for_user_group**](#manage_permissions_for_user_group) | **post** /api/v1/actions/userManagement/userGroups/{userGroupId}/permissions | +[**remove_group_members**](#remove_group_members) | **post** /api/v1/actions/userManagement/userGroups/{userGroupId}/removeMembers | +[**remove_users_user_groups**](#remove_users_user_groups) | **post** /api/v1/actions/userManagement/removeUsersUserGroups | +[**revoke_permissions**](#revoke_permissions) | **post** /api/v1/actions/userManagement/revokePermissions | + +# **add_group_members** + +> add_group_members(user_group_iduser_management_user_group_members) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import user_management_api +from gooddata_api_client.model.user_management_user_group_members import UserManagementUserGroupMembers +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = user_management_api.UserManagementApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'userGroupId': "userGroupId_example", + } + body = UserManagementUserGroupMembers( + members=[ + UserManagementUserGroupMember( + id="id_example", + name="name_example", + ) + ], + ) + try: + api_response = api_instance.add_group_members( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->add_group_members: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**UserManagementUserGroupMembers**](../../models/UserManagementUserGroupMembers.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +userGroupId | UserGroupIdSchema | | + +# UserGroupIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#add_group_members.ApiResponseFor204) | No Content + +#### add_group_members.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **assign_permissions** + +> assign_permissions(permissions_assignment) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import user_management_api +from gooddata_api_client.model.permissions_assignment import PermissionsAssignment +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = user_management_api.UserManagementApi(api_client) + + # example passing only required values which don't have defaults set + body = PermissionsAssignment( + assignees=[ + AssigneeIdentifier( + id="id_example", + type="user", + ) + ], + data_sources=[ + UserManagementDataSourcePermissionAssignment( + id="id_example", + name="name_example", + permissions=[ + "MANAGE" + ], + ) + ], + workspaces=[ + UserManagementWorkspacePermissionAssignment( + hierarchy_permissions=[ + "MANAGE" + ], + id="id_example", + name="name_example", +, + ) + ], + ) + try: + api_response = api_instance.assign_permissions( + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->assign_permissions: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**PermissionsAssignment**](../../models/PermissionsAssignment.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#assign_permissions.ApiResponseFor200) | OK + +#### assign_permissions.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_group_members** + +> UserManagementUserGroupMembers get_group_members(user_group_id) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import user_management_api +from gooddata_api_client.model.user_management_user_group_members import UserManagementUserGroupMembers +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = user_management_api.UserManagementApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'userGroupId': "userGroupId_example", + } + try: + api_response = api_instance.get_group_members( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->get_group_members: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +userGroupId | UserGroupIdSchema | | + +# UserGroupIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_group_members.ApiResponseFor200) | OK + +#### get_group_members.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**UserManagementUserGroupMembers**](../../models/UserManagementUserGroupMembers.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_permissions_for_user** + +> UserManagementPermissionAssignments list_permissions_for_user(user_id) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import user_management_api +from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = user_management_api.UserManagementApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'userId': "userId_example", + } + try: + api_response = api_instance.list_permissions_for_user( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->list_permissions_for_user: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +userId | UserIdSchema | | + +# UserIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#list_permissions_for_user.ApiResponseFor200) | OK + +#### list_permissions_for_user.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**UserManagementPermissionAssignments**](../../models/UserManagementPermissionAssignments.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_permissions_for_user_group** + +> UserManagementPermissionAssignments list_permissions_for_user_group(user_group_id) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import user_management_api +from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = user_management_api.UserManagementApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'userGroupId': "userGroupId_example", + } + try: + api_response = api_instance.list_permissions_for_user_group( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->list_permissions_for_user_group: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +userGroupId | UserGroupIdSchema | | + +# UserGroupIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#list_permissions_for_user_group.ApiResponseFor200) | OK + +#### list_permissions_for_user_group.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**UserManagementPermissionAssignments**](../../models/UserManagementPermissionAssignments.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_user_groups** + +> UserManagementUserGroups list_user_groups() + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import user_management_api +from gooddata_api_client.model.user_management_user_groups import UserManagementUserGroups +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = user_management_api.UserManagementApi(api_client) + + # example passing only optional values + query_params = { + 'page': page=0, + 'size': size=20, + 'name': "name=charles", + 'workspace': "workspace=demo", + 'dataSource': "dataSource=demo-test-ds", + } + try: + api_response = api_instance.list_user_groups( + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->list_user_groups: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +page | PageSchema | | optional +size | SizeSchema | | optional +name | NameSchema | | optional +workspace | WorkspaceSchema | | optional +dataSource | DataSourceSchema | | optional + + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0value must be a 32 bit integer + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20value must be a 32 bit integer + +# NameSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# WorkspaceSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# DataSourceSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#list_user_groups.ApiResponseFor200) | OK + +#### list_user_groups.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**UserManagementUserGroups**](../../models/UserManagementUserGroups.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_users** + +> UserManagementUsers list_users() + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import user_management_api +from gooddata_api_client.model.user_management_users import UserManagementUsers +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = user_management_api.UserManagementApi(api_client) + + # example passing only optional values + query_params = { + 'page': page=0, + 'size': size=20, + 'name': "name=charles", + 'workspace': "workspace=demo", + 'group': "group=admin", + 'dataSource': "dataSource=demo-test-ds", + } + try: + api_response = api_instance.list_users( + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->list_users: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +page | PageSchema | | optional +size | SizeSchema | | optional +name | NameSchema | | optional +workspace | WorkspaceSchema | | optional +group | GroupSchema | | optional +dataSource | DataSourceSchema | | optional + + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0value must be a 32 bit integer + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20value must be a 32 bit integer + +# NameSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# WorkspaceSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# GroupSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# DataSourceSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#list_users.ApiResponseFor200) | OK + +#### list_users.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**UserManagementUsers**](../../models/UserManagementUsers.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_workspace_user_groups** + +> WorkspaceUserGroups list_workspace_user_groups(workspace_id) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import user_management_api +from gooddata_api_client.model.workspace_user_groups import WorkspaceUserGroups +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = user_management_api.UserManagementApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + try: + api_response = api_instance.list_workspace_user_groups( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->list_workspace_user_groups: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'page': page=0, + 'size': size=20, + 'name': "name=charles", + } + try: + api_response = api_instance.list_workspace_user_groups( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->list_workspace_user_groups: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +page | PageSchema | | optional +size | SizeSchema | | optional +name | NameSchema | | optional + + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0value must be a 32 bit integer + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20value must be a 32 bit integer + +# NameSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#list_workspace_user_groups.ApiResponseFor200) | OK + +#### list_workspace_user_groups.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**WorkspaceUserGroups**](../../models/WorkspaceUserGroups.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_workspace_users** + +> WorkspaceUsers list_workspace_users(workspace_id) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import user_management_api +from gooddata_api_client.model.workspace_users import WorkspaceUsers +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = user_management_api.UserManagementApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + } + try: + api_response = api_instance.list_workspace_users( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->list_workspace_users: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + query_params = { + 'page': page=0, + 'size': size=20, + 'name': "name=charles", + } + try: + api_response = api_instance.list_workspace_users( + path_params=path_params, + query_params=query_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->list_workspace_users: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query_params | RequestQueryParams | | +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +page | PageSchema | | optional +size | SizeSchema | | optional +name | NameSchema | | optional + + +# PageSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 0value must be a 32 bit integer + +# SizeSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | if omitted the server will use the default value of 20value must be a 32 bit integer + +# NameSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#list_workspace_users.ApiResponseFor200) | OK + +#### list_workspace_users.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor200ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**WorkspaceUsers**](../../models/WorkspaceUsers.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_permissions_for_user** + +> manage_permissions_for_user(user_iduser_management_permission_assignments) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import user_management_api +from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = user_management_api.UserManagementApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'userId': "userId_example", + } + body = UserManagementPermissionAssignments( + data_sources=[ + UserManagementDataSourcePermissionAssignment( + id="id_example", + name="name_example", + permissions=[ + "MANAGE" + ], + ) + ], + workspaces=[ + UserManagementWorkspacePermissionAssignment( + hierarchy_permissions=[ + "MANAGE" + ], + id="id_example", + name="name_example", +, + ) + ], + ) + try: + api_response = api_instance.manage_permissions_for_user( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->manage_permissions_for_user: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**UserManagementPermissionAssignments**](../../models/UserManagementPermissionAssignments.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +userId | UserIdSchema | | + +# UserIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#manage_permissions_for_user.ApiResponseFor204) | No Content + +#### manage_permissions_for_user.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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_permissions_for_user_group** + +> manage_permissions_for_user_group(user_group_iduser_management_permission_assignments) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import user_management_api +from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = user_management_api.UserManagementApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'userGroupId': "userGroupId_example", + } + body = UserManagementPermissionAssignments( + data_sources=[ + UserManagementDataSourcePermissionAssignment( + id="id_example", + name="name_example", + permissions=[ + "MANAGE" + ], + ) + ], + workspaces=[ + UserManagementWorkspacePermissionAssignment( + hierarchy_permissions=[ + "MANAGE" + ], + id="id_example", + name="name_example", +, + ) + ], + ) + try: + api_response = api_instance.manage_permissions_for_user_group( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->manage_permissions_for_user_group: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**UserManagementPermissionAssignments**](../../models/UserManagementPermissionAssignments.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +userGroupId | UserGroupIdSchema | | + +# UserGroupIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#manage_permissions_for_user_group.ApiResponseFor204) | No Content + +#### manage_permissions_for_user_group.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **remove_group_members** + +> remove_group_members(user_group_iduser_management_user_group_members) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import user_management_api +from gooddata_api_client.model.user_management_user_group_members import UserManagementUserGroupMembers +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = user_management_api.UserManagementApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'userGroupId': "userGroupId_example", + } + body = UserManagementUserGroupMembers( + members=[ + UserManagementUserGroupMember( + id="id_example", + name="name_example", + ) + ], + ) + try: + api_response = api_instance.remove_group_members( + path_params=path_params, + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->remove_group_members: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**UserManagementUserGroupMembers**](../../models/UserManagementUserGroupMembers.md) | | + + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +userGroupId | UserGroupIdSchema | | + +# UserGroupIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +204 | [ApiResponseFor204](#remove_group_members.ApiResponseFor204) | No Content + +#### remove_group_members.ApiResponseFor204 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **remove_users_user_groups** + +> remove_users_user_groups(assignee_identifier) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import user_management_api +from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = user_management_api.UserManagementApi(api_client) + + # example passing only required values which don't have defaults set + body = [ + AssigneeIdentifier( + id="id_example", + type="user", + ) + ] + try: + api_response = api_instance.remove_users_user_groups( + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->remove_users_user_groups: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AssigneeIdentifier**]({{complexTypePrefix}}AssigneeIdentifier.md) | [**AssigneeIdentifier**]({{complexTypePrefix}}AssigneeIdentifier.md) | [**AssigneeIdentifier**]({{complexTypePrefix}}AssigneeIdentifier.md) | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#remove_users_user_groups.ApiResponseFor200) | OK + +#### remove_users_user_groups.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **revoke_permissions** + +> revoke_permissions(permissions_assignment) + + + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import user_management_api +from gooddata_api_client.model.permissions_assignment import PermissionsAssignment +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = user_management_api.UserManagementApi(api_client) + + # example passing only required values which don't have defaults set + body = PermissionsAssignment( + assignees=[ + AssigneeIdentifier( + id="id_example", + type="user", + ) + ], + data_sources=[ + UserManagementDataSourcePermissionAssignment( + id="id_example", + name="name_example", + permissions=[ + "MANAGE" + ], + ) + ], + workspaces=[ + UserManagementWorkspacePermissionAssignment( + hierarchy_permissions=[ + "MANAGE" + ], + id="id_example", + name="name_example", +, + ) + ], + ) + try: + api_response = api_instance.revoke_permissions( + body=body, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->revoke_permissions: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**PermissionsAssignment**](../../models/PermissionsAssignment.md) | | + + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#revoke_permissions.ApiResponseFor200) | OK + +#### revoke_permissions.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/apis/tags/VisualExportApi.md b/gooddata-api-client/docs/apis/tags/VisualExportApi.md new file mode 100644 index 000000000..ad4085bc5 --- /dev/null +++ b/gooddata-api-client/docs/apis/tags/VisualExportApi.md @@ -0,0 +1,388 @@ + +# gooddata_api_client.apis.tags.visual_export_api.VisualExportApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_pdf_export**](#create_pdf_export) | **post** /api/v1/actions/workspaces/{workspaceId}/export/visual | Create visual - pdf export request +[**get_exported_file**](#get_exported_file) | **get** /api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId} | Retrieve exported files +[**get_metadata**](#get_metadata) | **get** /api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata | Retrieve metadata context + +# **create_pdf_export** + +> ExportResponse create_pdf_export(workspace_idvisual_export_request) + +Create visual - pdf export request + +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. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import visual_export_api +from gooddata_api_client.model.export_response import ExportResponse +from gooddata_api_client.model.visual_export_request import VisualExportRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + +# 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 = visual_export_api.VisualExportApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + } + header_params = { + } + body = VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata=dict(), + ) + try: + # Create visual - pdf export request + api_response = api_instance.create_pdf_export( + path_params=path_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualExportApi->create_pdf_export: %s\n" % e) + + # example passing only optional values + path_params = { + 'workspaceId': "workspaceId_example", + } + header_params = { + 'X-Gdc-Debug': False, + } + body = VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata=dict(), + ) + try: + # Create visual - pdf export request + api_response = api_instance.create_pdf_export( + path_params=path_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualExportApi->create_pdf_export: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +body | typing.Union[SchemaForRequestBodyApplicationJson] | required | +header_params | RequestHeaderParams | | +path_params | RequestPathParams | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### body + +# SchemaForRequestBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**VisualExportRequest**](../../models/VisualExportRequest.md) | | + + +### header_params +#### RequestHeaderParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +X-Gdc-Debug | XGdcDebugSchema | | optional + +# XGdcDebugSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | if omitted the server will use the default value of False + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +201 | [ApiResponseFor201](#create_pdf_export.ApiResponseFor201) | Visual export request created successfully. + +#### create_pdf_export.ApiResponseFor201 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor201ResponseBodyApplicationJson, ] | | +headers | Unset | headers were not defined | + +# SchemaFor201ResponseBodyApplicationJson +Type | Description | Notes +------------- | ------------- | ------------- +[**ExportResponse**](../../models/ExportResponse.md) | | + + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_exported_file** + +> file_type get_exported_file(workspace_idexport_id) + +Retrieve exported files + +Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import visual_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(configuration) as api_client: + # Create an instance of the API class + api_instance = visual_export_api.VisualExportApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'exportId': "exportId_example", + } + try: + # Retrieve exported files + api_response = api_instance.get_exported_file( + path_params=path_params, + ) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualExportApi->get_exported_file: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/pdf', 'application/zip', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +exportId | ExportIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ExportIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_exported_file.ApiResponseFor200) | Binary export result. +202 | [ApiResponseFor202](#get_exported_file.ApiResponseFor202) | Request is accepted, provided exportId exists, but export is not yet ready. + +#### get_exported_file.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor200ResponseBodyApplicationPdf, SchemaFor200ResponseBodyApplicationZip, ] | | +headers | ResponseHeadersFor200 | | + +# SchemaFor200ResponseBodyApplicationPdf + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +# SchemaFor200ResponseBodyApplicationZip + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | +#### ResponseHeadersFor200 + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +Content-Disposition | ContentDispositionSchema | | optional + +# ContentDispositionSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + + +#### get_exported_file.ApiResponseFor202 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[SchemaFor202ResponseBodyApplicationPdf, SchemaFor202ResponseBodyApplicationZip, ] | | +headers | Unset | headers were not defined | + +# SchemaFor202ResponseBodyApplicationPdf + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +# SchemaFor202ResponseBodyApplicationZip + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md) + +# **get_metadata** + +> get_metadata(workspace_idexport_id) + +Retrieve metadata context + +This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. + +### Example + +```python +import gooddata_api_client +from gooddata_api_client.apis.tags import visual_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(configuration) as api_client: + # Create an instance of the API class + api_instance = visual_export_api.VisualExportApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'workspaceId': "workspaceId_example", + 'exportId': "exportId_example", + } + try: + # Retrieve metadata context + api_response = api_instance.get_metadata( + path_params=path_params, + ) + except gooddata_api_client.ApiException as e: + print("Exception when calling VisualExportApi->get_metadata: %s\n" % e) +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +path_params | RequestPathParams | | +accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client +stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParams + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +workspaceId | WorkspaceIdSchema | | +exportId | ExportIdSchema | | + +# WorkspaceIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# ExportIdSchema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +### Return Types, Responses + +Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ApiResponseFor200](#get_metadata.ApiResponseFor200) | Json metadata representation + +#### get_metadata.ApiResponseFor200 +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | typing.Union[Unset, ] | | +headers | Unset | headers were not defined | + +### Authorization + +No authorization required + +[[Back to top]](#__pageTop) [[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/models/AacAnalyticsModel.md b/gooddata-api-client/docs/models/AacAnalyticsModel.md new file mode 100644 index 000000000..392fc08a5 --- /dev/null +++ b/gooddata-api-client/docs/models/AacAnalyticsModel.md @@ -0,0 +1,91 @@ +# gooddata_api_client.model.aac_analytics_model.AacAnalyticsModel + +AAC analytics model representation compatible with Analytics-as-Code YAML format. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | AAC analytics model representation compatible with Analytics-as-Code YAML format. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attribute_hierarchies](#attribute_hierarchies)** | list, tuple, | tuple, | An array of attribute hierarchies. | [optional] +**[dashboards](#dashboards)** | list, tuple, | tuple, | An array of dashboards. | [optional] +**[metrics](#metrics)** | list, tuple, | tuple, | An array of metrics. | [optional] +**[plugins](#plugins)** | list, tuple, | tuple, | An array of dashboard plugins. | [optional] +**[visualizations](#visualizations)** | list, tuple, | tuple, | An array of visualizations. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attribute_hierarchies + +An array of attribute hierarchies. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | An array of attribute hierarchies. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacAttributeHierarchy**](AacAttributeHierarchy.md) | [**AacAttributeHierarchy**](AacAttributeHierarchy.md) | [**AacAttributeHierarchy**](AacAttributeHierarchy.md) | | + +# dashboards + +An array of dashboards. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | An array of dashboards. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacDashboard**](AacDashboard.md) | [**AacDashboard**](AacDashboard.md) | [**AacDashboard**](AacDashboard.md) | | + +# metrics + +An array of metrics. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | An array of metrics. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacMetric**](AacMetric.md) | [**AacMetric**](AacMetric.md) | [**AacMetric**](AacMetric.md) | | + +# plugins + +An array of dashboard plugins. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | An array of dashboard plugins. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacPlugin**](AacPlugin.md) | [**AacPlugin**](AacPlugin.md) | [**AacPlugin**](AacPlugin.md) | | + +# visualizations + +An array of visualizations. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | An array of visualizations. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacVisualization**](AacVisualization.md) | [**AacVisualization**](AacVisualization.md) | [**AacVisualization**](AacVisualization.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacAttributeHierarchy.md b/gooddata-api-client/docs/models/AacAttributeHierarchy.md new file mode 100644 index 000000000..569b8ad26 --- /dev/null +++ b/gooddata-api-client/docs/models/AacAttributeHierarchy.md @@ -0,0 +1,50 @@ +# gooddata_api_client.model.aac_attribute_hierarchy.AacAttributeHierarchy + +AAC attribute hierarchy definition. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | AAC attribute hierarchy definition. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | list, tuple, | tuple, | Ordered list of attribute identifiers (first is top level). | +**id** | str, | str, | Unique identifier of the attribute hierarchy. | +**type** | str, | str, | Attribute hierarchy type discriminator. | +**description** | str, | str, | Attribute hierarchy description. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +Ordered list of attribute identifiers (first is top level). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Ordered list of attribute identifiers (first is top level). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Ordered list of attribute identifiers (first is top level). | + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacContainerWidget.md b/gooddata-api-client/docs/models/AacContainerWidget.md new file mode 100644 index 000000000..5e7dbe65a --- /dev/null +++ b/gooddata-api-client/docs/models/AacContainerWidget.md @@ -0,0 +1,249 @@ +# gooddata_api_client.model.aac_container_widget.AacContainerWidget + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[sections](#sections)** | list, tuple, | tuple, | Nested sections for layout widgets. | +**[additionalProperties](#additionalProperties)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**columns** | decimal.Decimal, int, | decimal.Decimal, | Widget width in grid columns (GAAC). | [optional] value must be a 32 bit integer +**container** | str, | str, | Container widget identifier. | [optional] +**content** | str, | str, | Rich text content. | [optional] +**date** | str, | str, | Date dataset for filtering. | [optional] +**[description](#description)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] +**drill_down** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**enable_section_headers** | bool, | BoolClass, | Whether section headers are enabled for container widgets. | [optional] +**[ignore_dashboard_filters](#ignore_dashboard_filters)** | list, tuple, | tuple, | Deprecated. Use ignoredFilters instead. | [optional] +**[ignored_filters](#ignored_filters)** | list, tuple, | tuple, | A list of dashboard filters to be ignored for this widget (GAAC). | [optional] +**[interactions](#interactions)** | list, tuple, | tuple, | Widget interactions (GAAC). | [optional] +**layout_direction** | str, | str, | Layout direction for container widgets. | [optional] +**metric** | str, | str, | Inline metric reference. | [optional] +**rows** | decimal.Decimal, int, | decimal.Decimal, | Widget height in grid rows (GAAC). | [optional] value must be a 32 bit integer +**size** | [**AacWidgetSize**](AacWidgetSize.md) | [**AacWidgetSize**](AacWidgetSize.md) | | [optional] +**[title](#title)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] +**type** | str, | str, | Widget type. | [optional] +**visualization** | str, | str, | Visualization ID reference. | [optional] +**[visualizations](#visualizations)** | list, tuple, | tuple, | Visualization switcher items. | [optional] +**zoom_data** | bool, | BoolClass, | Enable zooming to the data for certain visualization types (GAAC). | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# sections + +Nested sections for layout widgets. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Nested sections for layout widgets. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacSection**](AacSection.md) | [**AacSection**](AacSection.md) | [**AacSection**](AacSection.md) | | + +# additionalProperties + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | any string name can be used but the value must be the correct type | [optional] + +# description + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | bool, | BoolClass, | | must be one of [False, ] +[one_of_2](#one_of_2) | str, | str, | | must be one of ["inherit", ] + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | must be one of [False, ] + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | must be one of ["inherit", ] + +# ignore_dashboard_filters + +Deprecated. Use ignoredFilters instead. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Deprecated. Use ignoredFilters instead. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Deprecated. Use ignoredFilters instead. | + +# ignored_filters + +A list of dashboard filters to be ignored for this widget (GAAC). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | A list of dashboard filters to be ignored for this widget (GAAC). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | A list of dashboard filters to be ignored for this widget (GAAC). | + +# interactions + +Widget interactions (GAAC). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Widget interactions (GAAC). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | + +# title + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | bool, | BoolClass, | | must be one of [False, ] + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | must be one of [False, ] + +# visualizations + +Visualization switcher items. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Visualization switcher items. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacWidget**](AacWidget.md) | [**AacWidget**](AacWidget.md) | [**AacWidget**](AacWidget.md) | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_2](#all_of_2) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacDashboard.md b/gooddata-api-client/docs/models/AacDashboard.md new file mode 100644 index 000000000..b6f58658b --- /dev/null +++ b/gooddata-api-client/docs/models/AacDashboard.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.aac_dashboard.AacDashboard + +AAC dashboard definition. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | AAC dashboard definition. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AacDashboardWithTabs](AacDashboardWithTabs.md) | [**AacDashboardWithTabs**](AacDashboardWithTabs.md) | [**AacDashboardWithTabs**](AacDashboardWithTabs.md) | | +[AacDashboardWithoutTabs](AacDashboardWithoutTabs.md) | [**AacDashboardWithoutTabs**](AacDashboardWithoutTabs.md) | [**AacDashboardWithoutTabs**](AacDashboardWithoutTabs.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacDashboardFilter.md b/gooddata-api-client/docs/models/AacDashboardFilter.md new file mode 100644 index 000000000..a0357e5b1 --- /dev/null +++ b/gooddata-api-client/docs/models/AacDashboardFilter.md @@ -0,0 +1,113 @@ +# gooddata_api_client.model.aac_dashboard_filter.AacDashboardFilter + +Tab-specific filters. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Tab-specific filters. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**type** | str, | str, | Filter type. | +**date** | str, | str, | Date dataset reference. | [optional] +**display_as** | str, | str, | Display as label. | [optional] +**[from](#from)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] +**granularity** | str, | str, | Date granularity. | [optional] +**[metric_filters](#metric_filters)** | list, tuple, | tuple, | Metric filters for validation. | [optional] +**mode** | str, | str, | Filter mode. | [optional] +**multiselect** | bool, | BoolClass, | Whether multiselect is enabled. | [optional] +**[parents](#parents)** | list, tuple, | tuple, | Parent filter references. | [optional] +**state** | [**AacFilterState**](AacFilterState.md) | [**AacFilterState**](AacFilterState.md) | | [optional] +**title** | str, | str, | Filter title. | [optional] +**[to](#to)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] +**using** | str, | str, | Attribute or label to filter by. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# from + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +# metric_filters + +Metric filters for validation. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metric filters for validation. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metric filters for validation. | + +# parents + +Parent filter references. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Parent filter references. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | + +# to + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacDashboardPermissions.md b/gooddata-api-client/docs/models/AacDashboardPermissions.md new file mode 100644 index 000000000..23a36da48 --- /dev/null +++ b/gooddata-api-client/docs/models/AacDashboardPermissions.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.aac_dashboard_permissions.AacDashboardPermissions + +Dashboard permissions. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Dashboard permissions. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**edit** | [**AacPermission**](AacPermission.md) | [**AacPermission**](AacPermission.md) | | [optional] +**share** | [**AacPermission**](AacPermission.md) | [**AacPermission**](AacPermission.md) | | [optional] +**view** | [**AacPermission**](AacPermission.md) | [**AacPermission**](AacPermission.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacDashboardPluginLink.md b/gooddata-api-client/docs/models/AacDashboardPluginLink.md new file mode 100644 index 000000000..60945a4d7 --- /dev/null +++ b/gooddata-api-client/docs/models/AacDashboardPluginLink.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.aac_dashboard_plugin_link.AacDashboardPluginLink + +Dashboard plugins. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Dashboard plugins. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Plugin ID. | +**parameters** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacDashboardWithTabs.md b/gooddata-api-client/docs/models/AacDashboardWithTabs.md new file mode 100644 index 000000000..c369c83f8 --- /dev/null +++ b/gooddata-api-client/docs/models/AacDashboardWithTabs.md @@ -0,0 +1,147 @@ +# gooddata_api_client.model.aac_dashboard_with_tabs.AacDashboardWithTabs + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[tabs](#tabs)** | list, tuple, | tuple, | Dashboard tabs (for tabbed dashboards). | +**id** | str, | str, | Unique identifier of the dashboard. | +**type** | str, | str, | Dashboard type discriminator. | +**active_tab_id** | str, | str, | Active tab ID for tabbed dashboards. | [optional] +**cross_filtering** | bool, | BoolClass, | Whether cross filtering is enabled. | [optional] +**description** | str, | str, | Dashboard description. | [optional] +**enable_section_headers** | bool, | BoolClass, | Whether section headers are enabled. | [optional] +**filter_views** | bool, | BoolClass, | Whether filter views are enabled. | [optional] +**[filters](#filters)** | dict, frozendict.frozendict, | frozendict.frozendict, | Dashboard filters. | [optional] +**permissions** | [**AacDashboardPermissions**](AacDashboardPermissions.md) | [**AacDashboardPermissions**](AacDashboardPermissions.md) | | [optional] +**[plugins](#plugins)** | list, tuple, | tuple, | Dashboard plugins. | [optional] +**[sections](#sections)** | list, tuple, | tuple, | Dashboard sections (for non-tabbed dashboards). | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**user_filters_reset** | bool, | BoolClass, | Whether user can reset custom filters. | [optional] +**user_filters_save** | bool, | BoolClass, | Whether user filter settings are stored. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tabs + +Dashboard tabs (for tabbed dashboards). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Dashboard tabs (for tabbed dashboards). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacTab**](AacTab.md) | [**AacTab**](AacTab.md) | [**AacTab**](AacTab.md) | | + +# filters + +Dashboard filters. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Dashboard filters. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**AacDashboardFilter**](AacDashboardFilter.md) | [**AacDashboardFilter**](AacDashboardFilter.md) | any string name can be used but the value must be the correct type | [optional] + +# plugins + +Dashboard plugins. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Dashboard plugins. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[AacDashboardPluginLink](AacDashboardPluginLink.md) | [**AacDashboardPluginLink**](AacDashboardPluginLink.md) | [**AacDashboardPluginLink**](AacDashboardPluginLink.md) | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# sections + +Dashboard sections (for non-tabbed dashboards). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Dashboard sections (for non-tabbed dashboards). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacSection**](AacSection.md) | [**AacSection**](AacSection.md) | [**AacSection**](AacSection.md) | | + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacDashboardWithoutTabs.md b/gooddata-api-client/docs/models/AacDashboardWithoutTabs.md new file mode 100644 index 000000000..a71b8d526 --- /dev/null +++ b/gooddata-api-client/docs/models/AacDashboardWithoutTabs.md @@ -0,0 +1,168 @@ +# gooddata_api_client.model.aac_dashboard_without_tabs.AacDashboardWithoutTabs + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Unique identifier of the dashboard. | +**type** | str, | str, | Dashboard type discriminator. | +**active_tab_id** | str, | str, | Active tab ID for tabbed dashboards. | [optional] +**cross_filtering** | bool, | BoolClass, | Whether cross filtering is enabled. | [optional] +**description** | str, | str, | Dashboard description. | [optional] +**enable_section_headers** | bool, | BoolClass, | Whether section headers are enabled. | [optional] +**filter_views** | bool, | BoolClass, | Whether filter views are enabled. | [optional] +**[filters](#filters)** | dict, frozendict.frozendict, | frozendict.frozendict, | Dashboard filters. | [optional] +**permissions** | [**AacDashboardPermissions**](AacDashboardPermissions.md) | [**AacDashboardPermissions**](AacDashboardPermissions.md) | | [optional] +**[plugins](#plugins)** | list, tuple, | tuple, | Dashboard plugins. | [optional] +**[sections](#sections)** | list, tuple, | tuple, | Dashboard sections (for non-tabbed dashboards). | [optional] +**[tabs](#tabs)** | list, tuple, | tuple, | Dashboard tabs (for tabbed dashboards). | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**user_filters_reset** | bool, | BoolClass, | Whether user can reset custom filters. | [optional] +**user_filters_save** | bool, | BoolClass, | Whether user filter settings are stored. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# filters + +Dashboard filters. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Dashboard filters. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**AacDashboardFilter**](AacDashboardFilter.md) | [**AacDashboardFilter**](AacDashboardFilter.md) | any string name can be used but the value must be the correct type | [optional] + +# plugins + +Dashboard plugins. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Dashboard plugins. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[AacDashboardPluginLink](AacDashboardPluginLink.md) | [**AacDashboardPluginLink**](AacDashboardPluginLink.md) | [**AacDashboardPluginLink**](AacDashboardPluginLink.md) | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# sections + +Dashboard sections (for non-tabbed dashboards). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Dashboard sections (for non-tabbed dashboards). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacSection**](AacSection.md) | [**AacSection**](AacSection.md) | [**AacSection**](AacSection.md) | | + +# tabs + +Dashboard tabs (for tabbed dashboards). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Dashboard tabs (for tabbed dashboards). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacTab**](AacTab.md) | [**AacTab**](AacTab.md) | [**AacTab**](AacTab.md) | | + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacDataset.md b/gooddata-api-client/docs/models/AacDataset.md new file mode 100644 index 000000000..07d9484a5 --- /dev/null +++ b/gooddata-api-client/docs/models/AacDataset.md @@ -0,0 +1,128 @@ +# gooddata_api_client.model.aac_dataset.AacDataset + +AAC dataset definition. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | AAC dataset definition. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Unique identifier of the dataset. | +**type** | str, | str, | Dataset type discriminator. | +**data_source** | str, | str, | Data source ID. | [optional] +**description** | str, | str, | Dataset description. | [optional] +**[fields](#fields)** | dict, frozendict.frozendict, | frozendict.frozendict, | Dataset fields (attributes, facts, aggregated facts). | [optional] +**precedence** | decimal.Decimal, int, | decimal.Decimal, | Precedence value for aggregate awareness. | [optional] value must be a 32 bit integer +**[primary_key](#primary_key)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Primary key column(s). Accepts either a single string or an array of strings. | [optional] +**[references](#references)** | list, tuple, | tuple, | References to other datasets. | [optional] +**sql** | str, | str, | SQL statement defining this dataset. | [optional] +**table_path** | str, | str, | Table path in the data source. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**[workspace_data_filters](#workspace_data_filters)** | list, tuple, | tuple, | Workspace data filters. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# fields + +Dataset fields (attributes, facts, aggregated facts). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Dataset fields (attributes, facts, aggregated facts). | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**AacField**](AacField.md) | [**AacField**](AacField.md) | any string name can be used but the value must be the correct type | [optional] + +# primary_key + +Primary key column(s). Accepts either a single string or an array of strings. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Primary key column(s). Accepts either a single string or an array of strings. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | list, tuple, | tuple, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# references + +References to other datasets. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | References to other datasets. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacReference**](AacReference.md) | [**AacReference**](AacReference.md) | [**AacReference**](AacReference.md) | | + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +# workspace_data_filters + +Workspace data filters. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Workspace data filters. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacWorkspaceDataFilter**](AacWorkspaceDataFilter.md) | [**AacWorkspaceDataFilter**](AacWorkspaceDataFilter.md) | [**AacWorkspaceDataFilter**](AacWorkspaceDataFilter.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacDateDataset.md b/gooddata-api-client/docs/models/AacDateDataset.md new file mode 100644 index 000000000..c939e7499 --- /dev/null +++ b/gooddata-api-client/docs/models/AacDateDataset.md @@ -0,0 +1,52 @@ +# gooddata_api_client.model.aac_date_dataset.AacDateDataset + +AAC date dataset definition. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | AAC date dataset definition. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Unique identifier of the date dataset. | +**type** | str, | str, | Dataset type discriminator. | +**description** | str, | str, | Date dataset description. | [optional] +**[granularities](#granularities)** | list, tuple, | tuple, | List of granularities. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**title_base** | str, | str, | Title base for formatting. | [optional] +**title_pattern** | str, | str, | Title pattern for formatting. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# granularities + +List of granularities. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of granularities. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | List of granularities. | + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacField.md b/gooddata-api-client/docs/models/AacField.md new file mode 100644 index 000000000..ff0551500 --- /dev/null +++ b/gooddata-api-client/docs/models/AacField.md @@ -0,0 +1,59 @@ +# gooddata_api_client.model.aac_field.AacField + +AAC field definition (attribute, fact, or aggregated_fact). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | AAC field definition (attribute, fact, or aggregated_fact). | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**type** | str, | str, | Field type. | +**aggregated_as** | str, | str, | Aggregation method. | [optional] +**assigned_to** | str, | str, | Source fact ID for aggregated fact. | [optional] +**data_type** | str, | str, | Data type of the column. | [optional] must be one of ["INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", ] +**default_view** | str, | str, | Default view label ID. | [optional] +**description** | str, | str, | Field description. | [optional] +**is_hidden** | bool, | BoolClass, | Deprecated. Use showInAiResults instead. | [optional] +**[labels](#labels)** | dict, frozendict.frozendict, | frozendict.frozendict, | Attribute labels. | [optional] +**locale** | str, | str, | Locale for sorting. | [optional] +**show_in_ai_results** | bool, | BoolClass, | Whether to show in AI results. | [optional] +**sort_column** | str, | str, | Sort column name. | [optional] +**sort_direction** | str, | str, | Sort direction. | [optional] must be one of ["ASC", "DESC", ] +**source_column** | str, | str, | Source column in the physical database. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# labels + +Attribute labels. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Attribute labels. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**AacLabel**](AacLabel.md) | [**AacLabel**](AacLabel.md) | any string name can be used but the value must be the correct type | [optional] + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacFilterState.md b/gooddata-api-client/docs/models/AacFilterState.md new file mode 100644 index 000000000..1f7b62199 --- /dev/null +++ b/gooddata-api-client/docs/models/AacFilterState.md @@ -0,0 +1,46 @@ +# gooddata_api_client.model.aac_filter_state.AacFilterState + +Filter state. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Filter state. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[exclude](#exclude)** | list, tuple, | tuple, | Excluded values. | [optional] +**[include](#include)** | list, tuple, | tuple, | Included values. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# exclude + +Excluded values. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Excluded values. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Excluded values. | + +# include + +Included values. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included values. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Included values. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacGeoAreaConfig.md b/gooddata-api-client/docs/models/AacGeoAreaConfig.md new file mode 100644 index 000000000..de5213a7a --- /dev/null +++ b/gooddata-api-client/docs/models/AacGeoAreaConfig.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.aac_geo_area_config.AacGeoAreaConfig + +GEO area configuration. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | GEO area configuration. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**collection** | [**AacGeoCollectionIdentifier**](AacGeoCollectionIdentifier.md) | [**AacGeoCollectionIdentifier**](AacGeoCollectionIdentifier.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacGeoCollectionIdentifier.md b/gooddata-api-client/docs/models/AacGeoCollectionIdentifier.md new file mode 100644 index 000000000..c629fceec --- /dev/null +++ b/gooddata-api-client/docs/models/AacGeoCollectionIdentifier.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.aac_geo_collection_identifier.AacGeoCollectionIdentifier + +GEO collection configuration. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | GEO collection configuration. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Collection identifier. | +**kind** | str, | str, | Type of geo collection. | [optional] must be one of ["STATIC", "CUSTOM", ] if omitted the server will use the default value of "STATIC" +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacLabel.md b/gooddata-api-client/docs/models/AacLabel.md new file mode 100644 index 000000000..4f074b783 --- /dev/null +++ b/gooddata-api-client/docs/models/AacLabel.md @@ -0,0 +1,55 @@ +# gooddata_api_client.model.aac_label.AacLabel + +AAC label definition. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | AAC label definition. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data_type** | str, | str, | Data type of the column. | [optional] must be one of ["INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", ] +**description** | str, | str, | Label description. | [optional] +**geo_area_config** | [**AacGeoAreaConfig**](AacGeoAreaConfig.md) | [**AacGeoAreaConfig**](AacGeoAreaConfig.md) | | [optional] +**is_hidden** | bool, | BoolClass, | Deprecated. Use showInAiResults instead. | [optional] +**locale** | str, | str, | Locale for sorting. | [optional] +**show_in_ai_results** | bool, | BoolClass, | Whether to show in AI results. | [optional] +**source_column** | str, | str, | Source column name. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**[translations](#translations)** | list, tuple, | tuple, | Localized source columns. | [optional] +**value_type** | str, | str, | Value type. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +# translations + +Localized source columns. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Localized source columns. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacLabelTranslation**](AacLabelTranslation.md) | [**AacLabelTranslation**](AacLabelTranslation.md) | [**AacLabelTranslation**](AacLabelTranslation.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacLabelTranslation.md b/gooddata-api-client/docs/models/AacLabelTranslation.md new file mode 100644 index 000000000..c8ccaa45f --- /dev/null +++ b/gooddata-api-client/docs/models/AacLabelTranslation.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.aac_label_translation.AacLabelTranslation + +Localized source columns. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Localized source columns. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**source_column** | str, | str, | Source column for translation. | +**locale** | str, | str, | Locale identifier. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacLogicalModel.md b/gooddata-api-client/docs/models/AacLogicalModel.md new file mode 100644 index 000000000..a2a2a5d4b --- /dev/null +++ b/gooddata-api-client/docs/models/AacLogicalModel.md @@ -0,0 +1,46 @@ +# gooddata_api_client.model.aac_logical_model.AacLogicalModel + +AAC logical data model representation compatible with Analytics-as-Code YAML format. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | AAC logical data model representation compatible with Analytics-as-Code YAML format. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[datasets](#datasets)** | list, tuple, | tuple, | An array of datasets. | [optional] +**[date_datasets](#date_datasets)** | list, tuple, | tuple, | An array of date datasets. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# datasets + +An array of datasets. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | An array of datasets. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacDataset**](AacDataset.md) | [**AacDataset**](AacDataset.md) | [**AacDataset**](AacDataset.md) | | + +# date_datasets + +An array of date datasets. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | An array of date datasets. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacDateDataset**](AacDateDataset.md) | [**AacDateDataset**](AacDateDataset.md) | [**AacDateDataset**](AacDateDataset.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacMetric.md b/gooddata-api-client/docs/models/AacMetric.md new file mode 100644 index 000000000..8a1ea66b5 --- /dev/null +++ b/gooddata-api-client/docs/models/AacMetric.md @@ -0,0 +1,40 @@ +# gooddata_api_client.model.aac_metric.AacMetric + +AAC metric definition. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | AAC metric definition. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Unique identifier of the metric. | +**maql** | str, | str, | MAQL expression defining the metric. | +**type** | str, | str, | Metric type discriminator. | +**description** | str, | str, | Metric description. | [optional] +**format** | str, | str, | Default format for metric values. | [optional] +**is_hidden** | bool, | BoolClass, | Deprecated. Use showInAiResults instead. | [optional] +**is_hidden_from_kda** | bool, | BoolClass, | Whether to hide from key driver analysis. | [optional] +**show_in_ai_results** | bool, | BoolClass, | Whether to show in AI results. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacPermission.md b/gooddata-api-client/docs/models/AacPermission.md new file mode 100644 index 000000000..5589db12a --- /dev/null +++ b/gooddata-api-client/docs/models/AacPermission.md @@ -0,0 +1,47 @@ +# gooddata_api_client.model.aac_permission.AacPermission + +SHARE permission. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | SHARE permission. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**all** | bool, | BoolClass, | Grant to all users. | [optional] +**[user_groups](#user_groups)** | list, tuple, | tuple, | List of user group IDs. | [optional] +**[users](#users)** | list, tuple, | tuple, | List of user IDs. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# user_groups + +List of user group IDs. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of user group IDs. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | List of user group IDs. | + +# users + +List of user IDs. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of user IDs. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | List of user IDs. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacPlugin.md b/gooddata-api-client/docs/models/AacPlugin.md new file mode 100644 index 000000000..6f296fdd4 --- /dev/null +++ b/gooddata-api-client/docs/models/AacPlugin.md @@ -0,0 +1,36 @@ +# gooddata_api_client.model.aac_plugin.AacPlugin + +AAC dashboard plugin definition. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | AAC dashboard plugin definition. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Unique identifier of the plugin. | +**type** | str, | str, | Plugin type discriminator. | +**url** | str, | str, | URL of the plugin. | +**description** | str, | str, | Plugin description. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacQuery.md b/gooddata-api-client/docs/models/AacQuery.md new file mode 100644 index 000000000..1706db56d --- /dev/null +++ b/gooddata-api-client/docs/models/AacQuery.md @@ -0,0 +1,97 @@ +# gooddata_api_client.model.aac_query.AacQuery + +Query definition. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Query definition. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[fields](#fields)** | dict, frozendict.frozendict, | frozendict.frozendict, | Query fields map: localId -> field definition (identifier string or structured object). | +**[filter_by](#filter_by)** | dict, frozendict.frozendict, | frozendict.frozendict, | Query filters map: localId -> filter definition. | [optional] +**[sort_by](#sort_by)** | list, tuple, | tuple, | Sorting definitions. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# fields + +Query fields map: localId -> field definition (identifier string or structured object). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Query fields map: localId -> field definition (identifier string or structured object). | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[any_string_name](#any_string_name)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# any_string_name + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# filter_by + +Query filters map: localId -> filter definition. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Query filters map: localId -> filter definition. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**AacQueryFilter**](AacQueryFilter.md) | [**AacQueryFilter**](AacQueryFilter.md) | any string name can be used but the value must be the correct type | [optional] + +# sort_by + +Sorting definitions. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Sorting definitions. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacQueryFilter.md b/gooddata-api-client/docs/models/AacQueryFilter.md new file mode 100644 index 000000000..5986c9a31 --- /dev/null +++ b/gooddata-api-client/docs/models/AacQueryFilter.md @@ -0,0 +1,113 @@ +# gooddata_api_client.model.aac_query_filter.AacQueryFilter + +Layer filters. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Layer filters. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**type** | str, | str, | Filter type. | +**[additionalProperties](#additionalProperties)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**attribute** | str, | str, | Attribute for ranking filter (identifier or localId). | [optional] +**bottom** | decimal.Decimal, int, | decimal.Decimal, | Bottom N for ranking filter. | [optional] value must be a 32 bit integer +**condition** | str, | str, | Condition for metric value filter. | [optional] +**[dimensionality](#dimensionality)** | list, tuple, | tuple, | Dimensionality for metric value filter. | [optional] +**display_as** | str, | str, | Display as label (attribute filter). | [optional] +**[from](#from)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] +**granularity** | str, | str, | Date granularity (date filter). | [optional] +**null_values_as_zero** | bool, | BoolClass, | Null values are treated as zero (metric value filter). | [optional] +**state** | [**AacFilterState**](AacFilterState.md) | [**AacFilterState**](AacFilterState.md) | | [optional] +**[to](#to)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] +**top** | decimal.Decimal, int, | decimal.Decimal, | Top N for ranking filter. | [optional] value must be a 32 bit integer +**using** | str, | str, | Reference to attribute/label/date/metric/fact (type-prefixed id). | [optional] +**value** | decimal.Decimal, int, float, | decimal.Decimal, | Value for metric value filter. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# additionalProperties + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | any string name can be used but the value must be the correct type | [optional] + +# dimensionality + +Dimensionality for metric value filter. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Dimensionality for metric value filter. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Dimensionality for metric value filter. | + +# from + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +# to + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacReference.md b/gooddata-api-client/docs/models/AacReference.md new file mode 100644 index 000000000..6fc56293a --- /dev/null +++ b/gooddata-api-client/docs/models/AacReference.md @@ -0,0 +1,33 @@ +# gooddata_api_client.model.aac_reference.AacReference + +AAC reference to another dataset. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | AAC reference to another dataset. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[sources](#sources)** | list, tuple, | tuple, | Source columns for the reference. | +**dataset** | str, | str, | Target dataset ID. | +**multi_directional** | bool, | BoolClass, | Whether the reference is multi-directional. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# sources + +Source columns for the reference. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Source columns for the reference. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacReferenceSource**](AacReferenceSource.md) | [**AacReferenceSource**](AacReferenceSource.md) | [**AacReferenceSource**](AacReferenceSource.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacReferenceSource.md b/gooddata-api-client/docs/models/AacReferenceSource.md new file mode 100644 index 000000000..af327052d --- /dev/null +++ b/gooddata-api-client/docs/models/AacReferenceSource.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.aac_reference_source.AacReferenceSource + +Source columns for the reference. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Source columns for the reference. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**source_column** | str, | str, | Source column name. | +**data_type** | str, | str, | Data type of the column. | [optional] must be one of ["INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", ] +**target** | str, | str, | Target in the referenced dataset. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacRichTextWidget.md b/gooddata-api-client/docs/models/AacRichTextWidget.md new file mode 100644 index 000000000..1fe0fe966 --- /dev/null +++ b/gooddata-api-client/docs/models/AacRichTextWidget.md @@ -0,0 +1,249 @@ +# gooddata_api_client.model.aac_rich_text_widget.AacRichTextWidget + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**content** | str, | str, | Rich text content. | +**[additionalProperties](#additionalProperties)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**columns** | decimal.Decimal, int, | decimal.Decimal, | Widget width in grid columns (GAAC). | [optional] value must be a 32 bit integer +**container** | str, | str, | Container widget identifier. | [optional] +**date** | str, | str, | Date dataset for filtering. | [optional] +**[description](#description)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] +**drill_down** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**enable_section_headers** | bool, | BoolClass, | Whether section headers are enabled for container widgets. | [optional] +**[ignore_dashboard_filters](#ignore_dashboard_filters)** | list, tuple, | tuple, | Deprecated. Use ignoredFilters instead. | [optional] +**[ignored_filters](#ignored_filters)** | list, tuple, | tuple, | A list of dashboard filters to be ignored for this widget (GAAC). | [optional] +**[interactions](#interactions)** | list, tuple, | tuple, | Widget interactions (GAAC). | [optional] +**layout_direction** | str, | str, | Layout direction for container widgets. | [optional] +**metric** | str, | str, | Inline metric reference. | [optional] +**rows** | decimal.Decimal, int, | decimal.Decimal, | Widget height in grid rows (GAAC). | [optional] value must be a 32 bit integer +**[sections](#sections)** | list, tuple, | tuple, | Nested sections for layout widgets. | [optional] +**size** | [**AacWidgetSize**](AacWidgetSize.md) | [**AacWidgetSize**](AacWidgetSize.md) | | [optional] +**[title](#title)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] +**type** | str, | str, | Widget type. | [optional] +**visualization** | str, | str, | Visualization ID reference. | [optional] +**[visualizations](#visualizations)** | list, tuple, | tuple, | Visualization switcher items. | [optional] +**zoom_data** | bool, | BoolClass, | Enable zooming to the data for certain visualization types (GAAC). | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# additionalProperties + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | any string name can be used but the value must be the correct type | [optional] + +# description + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | bool, | BoolClass, | | must be one of [False, ] +[one_of_2](#one_of_2) | str, | str, | | must be one of ["inherit", ] + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | must be one of [False, ] + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | must be one of ["inherit", ] + +# ignore_dashboard_filters + +Deprecated. Use ignoredFilters instead. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Deprecated. Use ignoredFilters instead. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Deprecated. Use ignoredFilters instead. | + +# ignored_filters + +A list of dashboard filters to be ignored for this widget (GAAC). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | A list of dashboard filters to be ignored for this widget (GAAC). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | A list of dashboard filters to be ignored for this widget (GAAC). | + +# interactions + +Widget interactions (GAAC). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Widget interactions (GAAC). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | + +# sections + +Nested sections for layout widgets. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Nested sections for layout widgets. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacSection**](AacSection.md) | [**AacSection**](AacSection.md) | [**AacSection**](AacSection.md) | | + +# title + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | bool, | BoolClass, | | must be one of [False, ] + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | must be one of [False, ] + +# visualizations + +Visualization switcher items. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Visualization switcher items. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacWidget**](AacWidget.md) | [**AacWidget**](AacWidget.md) | [**AacWidget**](AacWidget.md) | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_2](#all_of_2) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacSection.md b/gooddata-api-client/docs/models/AacSection.md new file mode 100644 index 000000000..1b73e77e9 --- /dev/null +++ b/gooddata-api-client/docs/models/AacSection.md @@ -0,0 +1,34 @@ +# gooddata_api_client.model.aac_section.AacSection + +Sections within the tab. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Sections within the tab. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**description** | str, | str, | Section description. | [optional] +**header** | bool, | BoolClass, | Whether section header is visible. | [optional] +**title** | str, | str, | Section title. | [optional] +**[widgets](#widgets)** | list, tuple, | tuple, | Widgets in the section. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# widgets + +Widgets in the section. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Widgets in the section. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacWidget**](AacWidget.md) | [**AacWidget**](AacWidget.md) | [**AacWidget**](AacWidget.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacTab.md b/gooddata-api-client/docs/models/AacTab.md new file mode 100644 index 000000000..c7a5ac30c --- /dev/null +++ b/gooddata-api-client/docs/models/AacTab.md @@ -0,0 +1,48 @@ +# gooddata_api_client.model.aac_tab.AacTab + +Dashboard tabs (for tabbed dashboards). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Dashboard tabs (for tabbed dashboards). | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Unique identifier of the tab. | +**title** | str, | str, | Display title for the tab. | +**[filters](#filters)** | dict, frozendict.frozendict, | frozendict.frozendict, | Tab-specific filters. | [optional] +**[sections](#sections)** | list, tuple, | tuple, | Sections within the tab. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# filters + +Tab-specific filters. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Tab-specific filters. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**AacDashboardFilter**](AacDashboardFilter.md) | [**AacDashboardFilter**](AacDashboardFilter.md) | any string name can be used but the value must be the correct type | [optional] + +# sections + +Sections within the tab. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Sections within the tab. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacSection**](AacSection.md) | [**AacSection**](AacSection.md) | [**AacSection**](AacSection.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacVisualization.md b/gooddata-api-client/docs/models/AacVisualization.md new file mode 100644 index 000000000..4f3af7fb6 --- /dev/null +++ b/gooddata-api-client/docs/models/AacVisualization.md @@ -0,0 +1,24 @@ +# gooddata_api_client.model.aac_visualization.AacVisualization + +AAC visualization definition. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | AAC visualization definition. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AacVisualizationTableBuckets](AacVisualizationTableBuckets.md) | [**AacVisualizationTableBuckets**](AacVisualizationTableBuckets.md) | [**AacVisualizationTableBuckets**](AacVisualizationTableBuckets.md) | | +[AacVisualizationStackedBuckets](AacVisualizationStackedBuckets.md) | [**AacVisualizationStackedBuckets**](AacVisualizationStackedBuckets.md) | [**AacVisualizationStackedBuckets**](AacVisualizationStackedBuckets.md) | | +[AacVisualizationScatterBuckets](AacVisualizationScatterBuckets.md) | [**AacVisualizationScatterBuckets**](AacVisualizationScatterBuckets.md) | [**AacVisualizationScatterBuckets**](AacVisualizationScatterBuckets.md) | | +[AacVisualizationBubbleBuckets](AacVisualizationBubbleBuckets.md) | [**AacVisualizationBubbleBuckets**](AacVisualizationBubbleBuckets.md) | [**AacVisualizationBubbleBuckets**](AacVisualizationBubbleBuckets.md) | | +[AacVisualizationTrendBuckets](AacVisualizationTrendBuckets.md) | [**AacVisualizationTrendBuckets**](AacVisualizationTrendBuckets.md) | [**AacVisualizationTrendBuckets**](AacVisualizationTrendBuckets.md) | | +[AacVisualizationGeoBuckets](AacVisualizationGeoBuckets.md) | [**AacVisualizationGeoBuckets**](AacVisualizationGeoBuckets.md) | [**AacVisualizationGeoBuckets**](AacVisualizationGeoBuckets.md) | | +[AacVisualizationBasicBuckets](AacVisualizationBasicBuckets.md) | [**AacVisualizationBasicBuckets**](AacVisualizationBasicBuckets.md) | [**AacVisualizationBasicBuckets**](AacVisualizationBasicBuckets.md) | | +[AacVisualizationDependencyBuckets](AacVisualizationDependencyBuckets.md) | [**AacVisualizationDependencyBuckets**](AacVisualizationDependencyBuckets.md) | [**AacVisualizationDependencyBuckets**](AacVisualizationDependencyBuckets.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacVisualizationBasicBuckets.md b/gooddata-api-client/docs/models/AacVisualizationBasicBuckets.md new file mode 100644 index 000000000..588ffa6e0 --- /dev/null +++ b/gooddata-api-client/docs/models/AacVisualizationBasicBuckets.md @@ -0,0 +1,720 @@ +# gooddata_api_client.model.aac_visualization_basic_buckets.AacVisualizationBasicBuckets + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**query** | [**AacQuery**](AacQuery.md) | [**AacQuery**](AacQuery.md) | | +**id** | str, | str, | Unique identifier of the visualization. | +**type** | str, | str, | | must be one of ["bullet_chart", "combo_chart", "donut_chart", "funnel_chart", "headline_chart", "pie_chart", "pyramid_chart", "treemap_chart", "waterfall_chart", ] +**[additionalProperties](#additionalProperties)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[attributes](#attributes)** | list, tuple, | tuple, | Attributes bucket (for scatter). | [optional] +**[columns](#columns)** | list, tuple, | tuple, | Columns bucket (for tables). | [optional] +**config** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**description** | str, | str, | Visualization description. | [optional] +**from** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**is_hidden** | bool, | BoolClass, | Deprecated. Use showInAiResults instead. | [optional] +**[layers](#layers)** | list, tuple, | tuple, | Visualization data layers (for geo charts). | [optional] +**[metrics](#metrics)** | list, tuple, | tuple, | Metrics bucket. | [optional] +**[rows](#rows)** | list, tuple, | tuple, | Rows bucket (for tables). | [optional] +**[segment_by](#segment_by)** | list, tuple, | tuple, | Segment by attributes bucket. | [optional] +**show_in_ai_results** | bool, | BoolClass, | Whether to show in AI results. | [optional] +**[size_by](#size_by)** | list, tuple, | tuple, | Size by metrics bucket. | [optional] +**[stack_by](#stack_by)** | list, tuple, | tuple, | Stack by attributes bucket. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**to** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**[trend_by](#trend_by)** | list, tuple, | tuple, | Trend by attributes bucket. | [optional] +**[view_by](#view_by)** | list, tuple, | tuple, | View by attributes bucket. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# additionalProperties + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | any string name can be used but the value must be the correct type | [optional] + +# attributes + +Attributes bucket (for scatter). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Attributes bucket (for scatter). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# columns + +Columns bucket (for tables). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Columns bucket (for tables). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# layers + +Visualization data layers (for geo charts). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Visualization data layers (for geo charts). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacVisualizationLayer**](AacVisualizationLayer.md) | [**AacVisualizationLayer**](AacVisualizationLayer.md) | [**AacVisualizationLayer**](AacVisualizationLayer.md) | | + +# metrics + +Metrics bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metrics bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# rows + +Rows bucket (for tables). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Rows bucket (for tables). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# segment_by + +Segment by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Segment by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# size_by + +Size by metrics bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Size by metrics bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# stack_by + +Stack by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Stack by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +# trend_by + +Trend by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Trend by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# view_by + +View by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | View by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_2](#all_of_2) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_3](#all_of_3) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_4](#all_of_4) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_5](#all_of_5) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_6](#all_of_6) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_7](#all_of_7) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_8](#all_of_8) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_3 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_4 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_5 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_6 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_7 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_8 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacVisualizationBubbleBuckets.md b/gooddata-api-client/docs/models/AacVisualizationBubbleBuckets.md new file mode 100644 index 000000000..39b412bf2 --- /dev/null +++ b/gooddata-api-client/docs/models/AacVisualizationBubbleBuckets.md @@ -0,0 +1,699 @@ +# gooddata_api_client.model.aac_visualization_bubble_buckets.AacVisualizationBubbleBuckets + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**query** | [**AacQuery**](AacQuery.md) | [**AacQuery**](AacQuery.md) | | +**id** | str, | str, | Unique identifier of the visualization. | +**type** | str, | str, | | must be one of ["bubble_chart", ] +**[additionalProperties](#additionalProperties)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[attributes](#attributes)** | list, tuple, | tuple, | Attributes bucket (for scatter). | [optional] +**[columns](#columns)** | list, tuple, | tuple, | Columns bucket (for tables). | [optional] +**config** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**description** | str, | str, | Visualization description. | [optional] +**from** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**is_hidden** | bool, | BoolClass, | Deprecated. Use showInAiResults instead. | [optional] +**[layers](#layers)** | list, tuple, | tuple, | Visualization data layers (for geo charts). | [optional] +**[metrics](#metrics)** | list, tuple, | tuple, | Metrics bucket. | [optional] +**[rows](#rows)** | list, tuple, | tuple, | Rows bucket (for tables). | [optional] +**[segment_by](#segment_by)** | list, tuple, | tuple, | Segment by attributes bucket. | [optional] +**show_in_ai_results** | bool, | BoolClass, | Whether to show in AI results. | [optional] +**[size_by](#size_by)** | list, tuple, | tuple, | Size by metrics bucket. | [optional] +**[stack_by](#stack_by)** | list, tuple, | tuple, | Stack by attributes bucket. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**to** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**[trend_by](#trend_by)** | list, tuple, | tuple, | Trend by attributes bucket. | [optional] +**[view_by](#view_by)** | list, tuple, | tuple, | View by attributes bucket. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# additionalProperties + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | any string name can be used but the value must be the correct type | [optional] + +# attributes + +Attributes bucket (for scatter). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Attributes bucket (for scatter). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# columns + +Columns bucket (for tables). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Columns bucket (for tables). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# layers + +Visualization data layers (for geo charts). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Visualization data layers (for geo charts). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacVisualizationLayer**](AacVisualizationLayer.md) | [**AacVisualizationLayer**](AacVisualizationLayer.md) | [**AacVisualizationLayer**](AacVisualizationLayer.md) | | + +# metrics + +Metrics bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metrics bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# rows + +Rows bucket (for tables). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Rows bucket (for tables). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# segment_by + +Segment by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Segment by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# size_by + +Size by metrics bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Size by metrics bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# stack_by + +Stack by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Stack by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +# trend_by + +Trend by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Trend by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# view_by + +View by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | View by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_2](#all_of_2) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_3](#all_of_3) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_4](#all_of_4) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_5](#all_of_5) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_6](#all_of_6) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_7](#all_of_7) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_3 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_4 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_5 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_6 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_7 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacVisualizationDependencyBuckets.md b/gooddata-api-client/docs/models/AacVisualizationDependencyBuckets.md new file mode 100644 index 000000000..2297fb62b --- /dev/null +++ b/gooddata-api-client/docs/models/AacVisualizationDependencyBuckets.md @@ -0,0 +1,678 @@ +# gooddata_api_client.model.aac_visualization_dependency_buckets.AacVisualizationDependencyBuckets + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**query** | [**AacQuery**](AacQuery.md) | [**AacQuery**](AacQuery.md) | | +**id** | str, | str, | Unique identifier of the visualization. | +**type** | str, | str, | | must be one of ["dependency_wheel_chart", "sankey_chart", ] +**[additionalProperties](#additionalProperties)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[attributes](#attributes)** | list, tuple, | tuple, | Attributes bucket (for scatter). | [optional] +**[columns](#columns)** | list, tuple, | tuple, | Columns bucket (for tables). | [optional] +**config** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**description** | str, | str, | Visualization description. | [optional] +**from** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**is_hidden** | bool, | BoolClass, | Deprecated. Use showInAiResults instead. | [optional] +**[layers](#layers)** | list, tuple, | tuple, | Visualization data layers (for geo charts). | [optional] +**[metrics](#metrics)** | list, tuple, | tuple, | Metrics bucket. | [optional] +**[rows](#rows)** | list, tuple, | tuple, | Rows bucket (for tables). | [optional] +**[segment_by](#segment_by)** | list, tuple, | tuple, | Segment by attributes bucket. | [optional] +**show_in_ai_results** | bool, | BoolClass, | Whether to show in AI results. | [optional] +**[size_by](#size_by)** | list, tuple, | tuple, | Size by metrics bucket. | [optional] +**[stack_by](#stack_by)** | list, tuple, | tuple, | Stack by attributes bucket. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**to** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**[trend_by](#trend_by)** | list, tuple, | tuple, | Trend by attributes bucket. | [optional] +**[view_by](#view_by)** | list, tuple, | tuple, | View by attributes bucket. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# additionalProperties + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | any string name can be used but the value must be the correct type | [optional] + +# attributes + +Attributes bucket (for scatter). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Attributes bucket (for scatter). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# columns + +Columns bucket (for tables). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Columns bucket (for tables). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# layers + +Visualization data layers (for geo charts). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Visualization data layers (for geo charts). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacVisualizationLayer**](AacVisualizationLayer.md) | [**AacVisualizationLayer**](AacVisualizationLayer.md) | [**AacVisualizationLayer**](AacVisualizationLayer.md) | | + +# metrics + +Metrics bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metrics bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# rows + +Rows bucket (for tables). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Rows bucket (for tables). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# segment_by + +Segment by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Segment by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# size_by + +Size by metrics bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Size by metrics bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# stack_by + +Stack by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Stack by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +# trend_by + +Trend by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Trend by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# view_by + +View by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | View by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_2](#all_of_2) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_3](#all_of_3) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_4](#all_of_4) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_5](#all_of_5) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_6](#all_of_6) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_3 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_4 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_5 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_6 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacVisualizationGeoBuckets.md b/gooddata-api-client/docs/models/AacVisualizationGeoBuckets.md new file mode 100644 index 000000000..d83d46f7e --- /dev/null +++ b/gooddata-api-client/docs/models/AacVisualizationGeoBuckets.md @@ -0,0 +1,699 @@ +# gooddata_api_client.model.aac_visualization_geo_buckets.AacVisualizationGeoBuckets + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**query** | [**AacQuery**](AacQuery.md) | [**AacQuery**](AacQuery.md) | | +**id** | str, | str, | Unique identifier of the visualization. | +**type** | str, | str, | | must be one of ["geo_chart", "geo_area_chart", ] +**[additionalProperties](#additionalProperties)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[attributes](#attributes)** | list, tuple, | tuple, | Attributes bucket (for scatter). | [optional] +**[columns](#columns)** | list, tuple, | tuple, | Columns bucket (for tables). | [optional] +**config** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**description** | str, | str, | Visualization description. | [optional] +**from** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**is_hidden** | bool, | BoolClass, | Deprecated. Use showInAiResults instead. | [optional] +**[layers](#layers)** | list, tuple, | tuple, | Visualization data layers (for geo charts). | [optional] +**[metrics](#metrics)** | list, tuple, | tuple, | Metrics bucket. | [optional] +**[rows](#rows)** | list, tuple, | tuple, | Rows bucket (for tables). | [optional] +**[segment_by](#segment_by)** | list, tuple, | tuple, | Segment by attributes bucket. | [optional] +**show_in_ai_results** | bool, | BoolClass, | Whether to show in AI results. | [optional] +**[size_by](#size_by)** | list, tuple, | tuple, | Size by metrics bucket. | [optional] +**[stack_by](#stack_by)** | list, tuple, | tuple, | Stack by attributes bucket. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**to** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**[trend_by](#trend_by)** | list, tuple, | tuple, | Trend by attributes bucket. | [optional] +**[view_by](#view_by)** | list, tuple, | tuple, | View by attributes bucket. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# additionalProperties + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | any string name can be used but the value must be the correct type | [optional] + +# attributes + +Attributes bucket (for scatter). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Attributes bucket (for scatter). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# columns + +Columns bucket (for tables). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Columns bucket (for tables). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# layers + +Visualization data layers (for geo charts). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Visualization data layers (for geo charts). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacVisualizationLayer**](AacVisualizationLayer.md) | [**AacVisualizationLayer**](AacVisualizationLayer.md) | [**AacVisualizationLayer**](AacVisualizationLayer.md) | | + +# metrics + +Metrics bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metrics bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# rows + +Rows bucket (for tables). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Rows bucket (for tables). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# segment_by + +Segment by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Segment by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# size_by + +Size by metrics bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Size by metrics bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# stack_by + +Stack by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Stack by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +# trend_by + +Trend by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Trend by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# view_by + +View by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | View by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_2](#all_of_2) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_3](#all_of_3) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_4](#all_of_4) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_5](#all_of_5) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_6](#all_of_6) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_7](#all_of_7) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_3 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_4 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_5 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_6 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_7 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacVisualizationLayer.md b/gooddata-api-client/docs/models/AacVisualizationLayer.md new file mode 100644 index 000000000..b1a8054dc --- /dev/null +++ b/gooddata-api-client/docs/models/AacVisualizationLayer.md @@ -0,0 +1,216 @@ +# gooddata_api_client.model.aac_visualization_layer.AacVisualizationLayer + +Visualization data layers (for geo charts). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Visualization data layers (for geo charts). | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Unique identifier of the layer. | +**[additionalProperties](#additionalProperties)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**config** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**[filters](#filters)** | dict, frozendict.frozendict, | frozendict.frozendict, | Layer filters. | [optional] +**[metrics](#metrics)** | list, tuple, | tuple, | Layer metrics. | [optional] +**[segment_by](#segment_by)** | list, tuple, | tuple, | Layer segment by. | [optional] +**[sorts](#sorts)** | list, tuple, | tuple, | Layer sorting definitions. | [optional] +**title** | str, | str, | Layer title. | [optional] +**type** | str, | str, | Layer type. | [optional] +**[view_by](#view_by)** | list, tuple, | tuple, | Layer view by. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# additionalProperties + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | any string name can be used but the value must be the correct type | [optional] + +# filters + +Layer filters. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Layer filters. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**AacQueryFilter**](AacQueryFilter.md) | [**AacQueryFilter**](AacQueryFilter.md) | any string name can be used but the value must be the correct type | [optional] + +# metrics + +Layer metrics. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Layer metrics. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# segment_by + +Layer segment by. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Layer segment by. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# sorts + +Layer sorting definitions. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Layer sorting definitions. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | + +# view_by + +Layer view by. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Layer view by. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacVisualizationScatterBuckets.md b/gooddata-api-client/docs/models/AacVisualizationScatterBuckets.md new file mode 100644 index 000000000..1dc95889c --- /dev/null +++ b/gooddata-api-client/docs/models/AacVisualizationScatterBuckets.md @@ -0,0 +1,699 @@ +# gooddata_api_client.model.aac_visualization_scatter_buckets.AacVisualizationScatterBuckets + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**query** | [**AacQuery**](AacQuery.md) | [**AacQuery**](AacQuery.md) | | +**id** | str, | str, | Unique identifier of the visualization. | +**type** | str, | str, | | must be one of ["scatter_chart", ] +**[additionalProperties](#additionalProperties)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[attributes](#attributes)** | list, tuple, | tuple, | Attributes bucket (for scatter). | [optional] +**[columns](#columns)** | list, tuple, | tuple, | Columns bucket (for tables). | [optional] +**config** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**description** | str, | str, | Visualization description. | [optional] +**from** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**is_hidden** | bool, | BoolClass, | Deprecated. Use showInAiResults instead. | [optional] +**[layers](#layers)** | list, tuple, | tuple, | Visualization data layers (for geo charts). | [optional] +**[metrics](#metrics)** | list, tuple, | tuple, | Metrics bucket. | [optional] +**[rows](#rows)** | list, tuple, | tuple, | Rows bucket (for tables). | [optional] +**[segment_by](#segment_by)** | list, tuple, | tuple, | Segment by attributes bucket. | [optional] +**show_in_ai_results** | bool, | BoolClass, | Whether to show in AI results. | [optional] +**[size_by](#size_by)** | list, tuple, | tuple, | Size by metrics bucket. | [optional] +**[stack_by](#stack_by)** | list, tuple, | tuple, | Stack by attributes bucket. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**to** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**[trend_by](#trend_by)** | list, tuple, | tuple, | Trend by attributes bucket. | [optional] +**[view_by](#view_by)** | list, tuple, | tuple, | View by attributes bucket. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# additionalProperties + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | any string name can be used but the value must be the correct type | [optional] + +# attributes + +Attributes bucket (for scatter). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Attributes bucket (for scatter). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# columns + +Columns bucket (for tables). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Columns bucket (for tables). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# layers + +Visualization data layers (for geo charts). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Visualization data layers (for geo charts). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacVisualizationLayer**](AacVisualizationLayer.md) | [**AacVisualizationLayer**](AacVisualizationLayer.md) | [**AacVisualizationLayer**](AacVisualizationLayer.md) | | + +# metrics + +Metrics bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metrics bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# rows + +Rows bucket (for tables). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Rows bucket (for tables). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# segment_by + +Segment by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Segment by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# size_by + +Size by metrics bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Size by metrics bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# stack_by + +Stack by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Stack by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +# trend_by + +Trend by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Trend by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# view_by + +View by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | View by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_2](#all_of_2) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_3](#all_of_3) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_4](#all_of_4) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_5](#all_of_5) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_6](#all_of_6) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_7](#all_of_7) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_3 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_4 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_5 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_6 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_7 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacVisualizationStackedBuckets.md b/gooddata-api-client/docs/models/AacVisualizationStackedBuckets.md new file mode 100644 index 000000000..5fc092f43 --- /dev/null +++ b/gooddata-api-client/docs/models/AacVisualizationStackedBuckets.md @@ -0,0 +1,699 @@ +# gooddata_api_client.model.aac_visualization_stacked_buckets.AacVisualizationStackedBuckets + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**query** | [**AacQuery**](AacQuery.md) | [**AacQuery**](AacQuery.md) | | +**id** | str, | str, | Unique identifier of the visualization. | +**type** | str, | str, | | must be one of ["bar_chart", "column_chart", "area_chart", ] +**[additionalProperties](#additionalProperties)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[attributes](#attributes)** | list, tuple, | tuple, | Attributes bucket (for scatter). | [optional] +**[columns](#columns)** | list, tuple, | tuple, | Columns bucket (for tables). | [optional] +**config** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**description** | str, | str, | Visualization description. | [optional] +**from** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**is_hidden** | bool, | BoolClass, | Deprecated. Use showInAiResults instead. | [optional] +**[layers](#layers)** | list, tuple, | tuple, | Visualization data layers (for geo charts). | [optional] +**[metrics](#metrics)** | list, tuple, | tuple, | Metrics bucket. | [optional] +**[rows](#rows)** | list, tuple, | tuple, | Rows bucket (for tables). | [optional] +**[segment_by](#segment_by)** | list, tuple, | tuple, | Segment by attributes bucket. | [optional] +**show_in_ai_results** | bool, | BoolClass, | Whether to show in AI results. | [optional] +**[size_by](#size_by)** | list, tuple, | tuple, | Size by metrics bucket. | [optional] +**[stack_by](#stack_by)** | list, tuple, | tuple, | Stack by attributes bucket. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**to** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**[trend_by](#trend_by)** | list, tuple, | tuple, | Trend by attributes bucket. | [optional] +**[view_by](#view_by)** | list, tuple, | tuple, | View by attributes bucket. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# additionalProperties + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | any string name can be used but the value must be the correct type | [optional] + +# attributes + +Attributes bucket (for scatter). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Attributes bucket (for scatter). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# columns + +Columns bucket (for tables). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Columns bucket (for tables). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# layers + +Visualization data layers (for geo charts). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Visualization data layers (for geo charts). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacVisualizationLayer**](AacVisualizationLayer.md) | [**AacVisualizationLayer**](AacVisualizationLayer.md) | [**AacVisualizationLayer**](AacVisualizationLayer.md) | | + +# metrics + +Metrics bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metrics bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# rows + +Rows bucket (for tables). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Rows bucket (for tables). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# segment_by + +Segment by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Segment by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# size_by + +Size by metrics bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Size by metrics bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# stack_by + +Stack by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Stack by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +# trend_by + +Trend by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Trend by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# view_by + +View by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | View by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_2](#all_of_2) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_3](#all_of_3) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_4](#all_of_4) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_5](#all_of_5) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_6](#all_of_6) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_7](#all_of_7) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_3 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_4 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_5 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_6 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_7 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacVisualizationSwitcherWidget.md b/gooddata-api-client/docs/models/AacVisualizationSwitcherWidget.md new file mode 100644 index 000000000..59eebaae8 --- /dev/null +++ b/gooddata-api-client/docs/models/AacVisualizationSwitcherWidget.md @@ -0,0 +1,247 @@ +# gooddata_api_client.model.aac_visualization_switcher_widget.AacVisualizationSwitcherWidget + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[visualizations](#visualizations)** | list, tuple, | tuple, | | +**[additionalProperties](#additionalProperties)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**columns** | decimal.Decimal, int, | decimal.Decimal, | Widget width in grid columns (GAAC). | [optional] value must be a 32 bit integer +**container** | str, | str, | Container widget identifier. | [optional] +**content** | str, | str, | Rich text content. | [optional] +**date** | str, | str, | Date dataset for filtering. | [optional] +**[description](#description)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] +**drill_down** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**enable_section_headers** | bool, | BoolClass, | Whether section headers are enabled for container widgets. | [optional] +**[ignore_dashboard_filters](#ignore_dashboard_filters)** | list, tuple, | tuple, | Deprecated. Use ignoredFilters instead. | [optional] +**[ignored_filters](#ignored_filters)** | list, tuple, | tuple, | A list of dashboard filters to be ignored for this widget (GAAC). | [optional] +**[interactions](#interactions)** | list, tuple, | tuple, | Widget interactions (GAAC). | [optional] +**layout_direction** | str, | str, | Layout direction for container widgets. | [optional] +**metric** | str, | str, | Inline metric reference. | [optional] +**rows** | decimal.Decimal, int, | decimal.Decimal, | Widget height in grid rows (GAAC). | [optional] value must be a 32 bit integer +**[sections](#sections)** | list, tuple, | tuple, | Nested sections for layout widgets. | [optional] +**size** | [**AacWidgetSize**](AacWidgetSize.md) | [**AacWidgetSize**](AacWidgetSize.md) | | [optional] +**[title](#title)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] +**type** | str, | str, | Widget type. | [optional] +**visualization** | str, | str, | Visualization ID reference. | [optional] +**zoom_data** | bool, | BoolClass, | Enable zooming to the data for certain visualization types (GAAC). | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# visualizations + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacVisualizationWidget**](AacVisualizationWidget.md) | [**AacVisualizationWidget**](AacVisualizationWidget.md) | [**AacVisualizationWidget**](AacVisualizationWidget.md) | | + +# additionalProperties + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | any string name can be used but the value must be the correct type | [optional] + +# description + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | bool, | BoolClass, | | must be one of [False, ] +[one_of_2](#one_of_2) | str, | str, | | must be one of ["inherit", ] + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | must be one of [False, ] + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | must be one of ["inherit", ] + +# ignore_dashboard_filters + +Deprecated. Use ignoredFilters instead. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Deprecated. Use ignoredFilters instead. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Deprecated. Use ignoredFilters instead. | + +# ignored_filters + +A list of dashboard filters to be ignored for this widget (GAAC). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | A list of dashboard filters to be ignored for this widget (GAAC). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | A list of dashboard filters to be ignored for this widget (GAAC). | + +# interactions + +Widget interactions (GAAC). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Widget interactions (GAAC). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | + +# sections + +Nested sections for layout widgets. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Nested sections for layout widgets. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacSection**](AacSection.md) | [**AacSection**](AacSection.md) | [**AacSection**](AacSection.md) | | + +# title + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | bool, | BoolClass, | | must be one of [False, ] + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | must be one of [False, ] + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_2](#all_of_2) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacVisualizationTableBuckets.md b/gooddata-api-client/docs/models/AacVisualizationTableBuckets.md new file mode 100644 index 000000000..caf46e956 --- /dev/null +++ b/gooddata-api-client/docs/models/AacVisualizationTableBuckets.md @@ -0,0 +1,678 @@ +# gooddata_api_client.model.aac_visualization_table_buckets.AacVisualizationTableBuckets + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**query** | [**AacQuery**](AacQuery.md) | [**AacQuery**](AacQuery.md) | | +**id** | str, | str, | Unique identifier of the visualization. | +**type** | str, | str, | | must be one of ["table", "heatmap_chart", "repeater_chart", ] +**[additionalProperties](#additionalProperties)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[attributes](#attributes)** | list, tuple, | tuple, | Attributes bucket (for scatter). | [optional] +**[columns](#columns)** | list, tuple, | tuple, | Columns bucket (for tables). | [optional] +**config** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**description** | str, | str, | Visualization description. | [optional] +**from** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**is_hidden** | bool, | BoolClass, | Deprecated. Use showInAiResults instead. | [optional] +**[layers](#layers)** | list, tuple, | tuple, | Visualization data layers (for geo charts). | [optional] +**[metrics](#metrics)** | list, tuple, | tuple, | Metrics bucket. | [optional] +**[rows](#rows)** | list, tuple, | tuple, | Rows bucket (for tables). | [optional] +**[segment_by](#segment_by)** | list, tuple, | tuple, | Segment by attributes bucket. | [optional] +**show_in_ai_results** | bool, | BoolClass, | Whether to show in AI results. | [optional] +**[size_by](#size_by)** | list, tuple, | tuple, | Size by metrics bucket. | [optional] +**[stack_by](#stack_by)** | list, tuple, | tuple, | Stack by attributes bucket. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**to** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**[trend_by](#trend_by)** | list, tuple, | tuple, | Trend by attributes bucket. | [optional] +**[view_by](#view_by)** | list, tuple, | tuple, | View by attributes bucket. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# additionalProperties + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | any string name can be used but the value must be the correct type | [optional] + +# attributes + +Attributes bucket (for scatter). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Attributes bucket (for scatter). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# columns + +Columns bucket (for tables). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Columns bucket (for tables). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# layers + +Visualization data layers (for geo charts). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Visualization data layers (for geo charts). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacVisualizationLayer**](AacVisualizationLayer.md) | [**AacVisualizationLayer**](AacVisualizationLayer.md) | [**AacVisualizationLayer**](AacVisualizationLayer.md) | | + +# metrics + +Metrics bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metrics bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# rows + +Rows bucket (for tables). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Rows bucket (for tables). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# segment_by + +Segment by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Segment by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# size_by + +Size by metrics bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Size by metrics bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# stack_by + +Stack by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Stack by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +# trend_by + +Trend by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Trend by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# view_by + +View by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | View by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_2](#all_of_2) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_3](#all_of_3) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_4](#all_of_4) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_5](#all_of_5) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_6](#all_of_6) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_3 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_4 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_5 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_6 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacVisualizationTrendBuckets.md b/gooddata-api-client/docs/models/AacVisualizationTrendBuckets.md new file mode 100644 index 000000000..e70084caa --- /dev/null +++ b/gooddata-api-client/docs/models/AacVisualizationTrendBuckets.md @@ -0,0 +1,699 @@ +# gooddata_api_client.model.aac_visualization_trend_buckets.AacVisualizationTrendBuckets + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**query** | [**AacQuery**](AacQuery.md) | [**AacQuery**](AacQuery.md) | | +**id** | str, | str, | Unique identifier of the visualization. | +**type** | str, | str, | | must be one of ["line_chart", ] +**[additionalProperties](#additionalProperties)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[attributes](#attributes)** | list, tuple, | tuple, | Attributes bucket (for scatter). | [optional] +**[columns](#columns)** | list, tuple, | tuple, | Columns bucket (for tables). | [optional] +**config** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**description** | str, | str, | Visualization description. | [optional] +**from** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**is_hidden** | bool, | BoolClass, | Deprecated. Use showInAiResults instead. | [optional] +**[layers](#layers)** | list, tuple, | tuple, | Visualization data layers (for geo charts). | [optional] +**[metrics](#metrics)** | list, tuple, | tuple, | Metrics bucket. | [optional] +**[rows](#rows)** | list, tuple, | tuple, | Rows bucket (for tables). | [optional] +**[segment_by](#segment_by)** | list, tuple, | tuple, | Segment by attributes bucket. | [optional] +**show_in_ai_results** | bool, | BoolClass, | Whether to show in AI results. | [optional] +**[size_by](#size_by)** | list, tuple, | tuple, | Size by metrics bucket. | [optional] +**[stack_by](#stack_by)** | list, tuple, | tuple, | Stack by attributes bucket. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | Metadata tags. | [optional] +**title** | str, | str, | Human readable title. | [optional] +**to** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**[trend_by](#trend_by)** | list, tuple, | tuple, | Trend by attributes bucket. | [optional] +**[view_by](#view_by)** | list, tuple, | tuple, | View by attributes bucket. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# additionalProperties + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | any string name can be used but the value must be the correct type | [optional] + +# attributes + +Attributes bucket (for scatter). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Attributes bucket (for scatter). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# columns + +Columns bucket (for tables). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Columns bucket (for tables). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# layers + +Visualization data layers (for geo charts). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Visualization data layers (for geo charts). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacVisualizationLayer**](AacVisualizationLayer.md) | [**AacVisualizationLayer**](AacVisualizationLayer.md) | [**AacVisualizationLayer**](AacVisualizationLayer.md) | | + +# metrics + +Metrics bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metrics bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# rows + +Rows bucket (for tables). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Rows bucket (for tables). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# segment_by + +Segment by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Segment by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# size_by + +Size by metrics bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Size by metrics bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# stack_by + +Stack by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Stack by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# tags + +Metadata tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metadata tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Metadata tags. | + +# trend_by + +Trend by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Trend by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +# view_by + +View by attributes bucket. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | View by attributes bucket. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | +[one_of_2](#one_of_2) | None, | NoneClass, | | + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +None, | NoneClass, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_2](#all_of_2) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_3](#all_of_3) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_4](#all_of_4) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_5](#all_of_5) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_6](#all_of_6) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_7](#all_of_7) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_3 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_4 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_5 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_6 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_7 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacVisualizationWidget.md b/gooddata-api-client/docs/models/AacVisualizationWidget.md new file mode 100644 index 000000000..57e388d82 --- /dev/null +++ b/gooddata-api-client/docs/models/AacVisualizationWidget.md @@ -0,0 +1,249 @@ +# gooddata_api_client.model.aac_visualization_widget.AacVisualizationWidget + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**visualization** | str, | str, | Visualization ID reference. | +**[additionalProperties](#additionalProperties)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**columns** | decimal.Decimal, int, | decimal.Decimal, | Widget width in grid columns (GAAC). | [optional] value must be a 32 bit integer +**container** | str, | str, | Container widget identifier. | [optional] +**content** | str, | str, | Rich text content. | [optional] +**date** | str, | str, | Date dataset for filtering. | [optional] +**[description](#description)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] +**drill_down** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**enable_section_headers** | bool, | BoolClass, | Whether section headers are enabled for container widgets. | [optional] +**[ignore_dashboard_filters](#ignore_dashboard_filters)** | list, tuple, | tuple, | Deprecated. Use ignoredFilters instead. | [optional] +**[ignored_filters](#ignored_filters)** | list, tuple, | tuple, | A list of dashboard filters to be ignored for this widget (GAAC). | [optional] +**[interactions](#interactions)** | list, tuple, | tuple, | Widget interactions (GAAC). | [optional] +**layout_direction** | str, | str, | Layout direction for container widgets. | [optional] +**metric** | str, | str, | Inline metric reference. | [optional] +**rows** | decimal.Decimal, int, | decimal.Decimal, | Widget height in grid rows (GAAC). | [optional] value must be a 32 bit integer +**[sections](#sections)** | list, tuple, | tuple, | Nested sections for layout widgets. | [optional] +**size** | [**AacWidgetSize**](AacWidgetSize.md) | [**AacWidgetSize**](AacWidgetSize.md) | | [optional] +**[title](#title)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] +**type** | str, | str, | Widget type. | [optional] +**[visualizations](#visualizations)** | list, tuple, | tuple, | Visualization switcher items. | [optional] +**zoom_data** | bool, | BoolClass, | Enable zooming to the data for certain visualization types (GAAC). | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# additionalProperties + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | any string name can be used but the value must be the correct type | [optional] + +# description + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | bool, | BoolClass, | | must be one of [False, ] +[one_of_2](#one_of_2) | str, | str, | | must be one of ["inherit", ] + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | must be one of [False, ] + +# one_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | must be one of ["inherit", ] + +# ignore_dashboard_filters + +Deprecated. Use ignoredFilters instead. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Deprecated. Use ignoredFilters instead. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Deprecated. Use ignoredFilters instead. | + +# ignored_filters + +A list of dashboard filters to be ignored for this widget (GAAC). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | A list of dashboard filters to be ignored for this widget (GAAC). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | A list of dashboard filters to be ignored for this widget (GAAC). | + +# interactions + +Widget interactions (GAAC). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Widget interactions (GAAC). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | + +# sections + +Nested sections for layout widgets. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Nested sections for layout widgets. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacSection**](AacSection.md) | [**AacSection**](AacSection.md) | [**AacSection**](AacSection.md) | | + +# title + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | bool, | BoolClass, | | must be one of [False, ] + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bool, | BoolClass, | | must be one of [False, ] + +# visualizations + +Visualization switcher items. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Visualization switcher items. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AacWidget**](AacWidget.md) | [**AacWidget**](AacWidget.md) | [**AacWidget**](AacWidget.md) | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +[all_of_2](#all_of_2) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# all_of_2 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### not +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[not_schema](#not_schema) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# not_schema + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacWidget.md b/gooddata-api-client/docs/models/AacWidget.md new file mode 100644 index 000000000..a160e2511 --- /dev/null +++ b/gooddata-api-client/docs/models/AacWidget.md @@ -0,0 +1,20 @@ +# gooddata_api_client.model.aac_widget.AacWidget + +Widgets in the section. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Widgets in the section. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AacVisualizationWidget](AacVisualizationWidget.md) | [**AacVisualizationWidget**](AacVisualizationWidget.md) | [**AacVisualizationWidget**](AacVisualizationWidget.md) | | +[AacRichTextWidget](AacRichTextWidget.md) | [**AacRichTextWidget**](AacRichTextWidget.md) | [**AacRichTextWidget**](AacRichTextWidget.md) | | +[AacVisualizationSwitcherWidget](AacVisualizationSwitcherWidget.md) | [**AacVisualizationSwitcherWidget**](AacVisualizationSwitcherWidget.md) | [**AacVisualizationSwitcherWidget**](AacVisualizationSwitcherWidget.md) | | +[AacContainerWidget](AacContainerWidget.md) | [**AacContainerWidget**](AacContainerWidget.md) | [**AacContainerWidget**](AacContainerWidget.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacWidgetSize.md b/gooddata-api-client/docs/models/AacWidgetSize.md new file mode 100644 index 000000000..f09437822 --- /dev/null +++ b/gooddata-api-client/docs/models/AacWidgetSize.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.aac_widget_size.AacWidgetSize + +Deprecated widget size (legacy AAC). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Deprecated widget size (legacy AAC). | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**height** | decimal.Decimal, int, | decimal.Decimal, | Height in grid rows. | [optional] value must be a 32 bit integer +**height_as_ratio** | bool, | BoolClass, | Height definition mode. | [optional] +**width** | decimal.Decimal, int, | decimal.Decimal, | Width in grid columns. | [optional] value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AacWorkspaceDataFilter.md b/gooddata-api-client/docs/models/AacWorkspaceDataFilter.md new file mode 100644 index 000000000..9417dd11b --- /dev/null +++ b/gooddata-api-client/docs/models/AacWorkspaceDataFilter.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.aac_workspace_data_filter.AacWorkspaceDataFilter + +Workspace data filters. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Workspace data filters. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**source_column** | str, | str, | Source column name. | +**filter_id** | str, | str, | Filter identifier. | +**data_type** | str, | str, | Data type of the column. | must be one of ["INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ActiveObjectIdentification.md b/gooddata-api-client/docs/models/ActiveObjectIdentification.md new file mode 100644 index 000000000..1c596f766 --- /dev/null +++ b/gooddata-api-client/docs/models/ActiveObjectIdentification.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.active_object_identification.ActiveObjectIdentification + +Object, with which the user is actively working. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Object, with which the user is actively working. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Object ID. | +**type** | str, | str, | Object type, e.g. dashboard. | +**workspaceId** | str, | str, | Workspace ID. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AdHocAutomation.md b/gooddata-api-client/docs/models/AdHocAutomation.md new file mode 100644 index 000000000..3dab01de4 --- /dev/null +++ b/gooddata-api-client/docs/models/AdHocAutomation.md @@ -0,0 +1,156 @@ +# gooddata_api_client.model.ad_hoc_automation.AdHocAutomation + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**alert** | [**AutomationAlert**](AutomationAlert.md) | [**AutomationAlert**](AutomationAlert.md) | | [optional] +**analyticalDashboard** | [**DeclarativeAnalyticalDashboardIdentifier**](DeclarativeAnalyticalDashboardIdentifier.md) | [**DeclarativeAnalyticalDashboardIdentifier**](DeclarativeAnalyticalDashboardIdentifier.md) | | [optional] +**[dashboardTabularExports](#dashboardTabularExports)** | list, tuple, | tuple, | | [optional] +**description** | str, | str, | | [optional] +**[details](#details)** | dict, frozendict.frozendict, | frozendict.frozendict, | Additional details to be included in the automated message. | [optional] +**[externalRecipients](#externalRecipients)** | list, tuple, | tuple, | External recipients of the automation action results. | [optional] +**[imageExports](#imageExports)** | list, tuple, | tuple, | | [optional] +**metadata** | [**AutomationMetadata**](AutomationMetadata.md) | [**AutomationMetadata**](AutomationMetadata.md) | | [optional] +**notificationChannel** | [**DeclarativeNotificationChannelIdentifier**](DeclarativeNotificationChannelIdentifier.md) | [**DeclarativeNotificationChannelIdentifier**](DeclarativeNotificationChannelIdentifier.md) | | [optional] +**[rawExports](#rawExports)** | list, tuple, | tuple, | | [optional] +**[recipients](#recipients)** | list, tuple, | tuple, | | [optional] +**[slidesExports](#slidesExports)** | list, tuple, | tuple, | | [optional] +**[tabularExports](#tabularExports)** | list, tuple, | tuple, | | [optional] +**[tags](#tags)** | list, tuple, | tuple, | A list of tags. | [optional] +**title** | str, | str, | | [optional] +**[visualExports](#visualExports)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dashboardTabularExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AutomationDashboardTabularExport**](AutomationDashboardTabularExport.md) | [**AutomationDashboardTabularExport**](AutomationDashboardTabularExport.md) | [**AutomationDashboardTabularExport**](AutomationDashboardTabularExport.md) | | + +# details + +Additional details to be included in the automated message. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Additional details to be included in the automated message. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str, | str, | any string name can be used but the value must be the correct type Additional details to be included in the automated message. | [optional] + +# externalRecipients + +External recipients of the automation action results. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | External recipients of the automation action results. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AutomationExternalRecipient**](AutomationExternalRecipient.md) | [**AutomationExternalRecipient**](AutomationExternalRecipient.md) | [**AutomationExternalRecipient**](AutomationExternalRecipient.md) | | + +# imageExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AutomationImageExport**](AutomationImageExport.md) | [**AutomationImageExport**](AutomationImageExport.md) | [**AutomationImageExport**](AutomationImageExport.md) | | + +# rawExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AutomationRawExport**](AutomationRawExport.md) | [**AutomationRawExport**](AutomationRawExport.md) | [**AutomationRawExport**](AutomationRawExport.md) | | + +# recipients + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | + +# slidesExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AutomationSlidesExport**](AutomationSlidesExport.md) | [**AutomationSlidesExport**](AutomationSlidesExport.md) | [**AutomationSlidesExport**](AutomationSlidesExport.md) | | + +# tabularExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AutomationTabularExport**](AutomationTabularExport.md) | [**AutomationTabularExport**](AutomationTabularExport.md) | [**AutomationTabularExport**](AutomationTabularExport.md) | | + +# tags + +A list of tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | A list of tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# visualExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AutomationVisualExport**](AutomationVisualExport.md) | [**AutomationVisualExport**](AutomationVisualExport.md) | [**AutomationVisualExport**](AutomationVisualExport.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AfmCancelTokens.md b/gooddata-api-client/docs/models/AfmCancelTokens.md new file mode 100644 index 000000000..3afcc6c09 --- /dev/null +++ b/gooddata-api-client/docs/models/AfmCancelTokens.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.afm_cancel_tokens.AfmCancelTokens + +Any information related to cancellation. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Any information related to cancellation. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[resultIdToCancelTokenPairs](#resultIdToCancelTokenPairs)** | dict, frozendict.frozendict, | frozendict.frozendict, | resultId to cancel token pairs | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# resultIdToCancelTokenPairs + +resultId to cancel token pairs + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | resultId to cancel token pairs | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AfmValidDescendantsQuery.md b/gooddata-api-client/docs/models/AfmValidDescendantsQuery.md new file mode 100644 index 000000000..51de890b1 --- /dev/null +++ b/gooddata-api-client/docs/models/AfmValidDescendantsQuery.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.afm_valid_descendants_query.AfmValidDescendantsQuery + +Entity describing the valid descendants request. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Entity describing the valid descendants request. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | list, tuple, | tuple, | List of identifiers of the attributes to get the valid descendants for. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +List of identifiers of the attributes to get the valid descendants for. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of identifiers of the attributes to get the valid descendants for. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AfmObjectIdentifierAttribute**](AfmObjectIdentifierAttribute.md) | [**AfmObjectIdentifierAttribute**](AfmObjectIdentifierAttribute.md) | [**AfmObjectIdentifierAttribute**](AfmObjectIdentifierAttribute.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AfmValidDescendantsResponse.md b/gooddata-api-client/docs/models/AfmValidDescendantsResponse.md new file mode 100644 index 000000000..026057d27 --- /dev/null +++ b/gooddata-api-client/docs/models/AfmValidDescendantsResponse.md @@ -0,0 +1,45 @@ +# gooddata_api_client.model.afm_valid_descendants_response.AfmValidDescendantsResponse + +Entity describing the valid descendants response. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Entity describing the valid descendants response. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[validDescendants](#validDescendants)** | dict, frozendict.frozendict, | frozendict.frozendict, | Map of attribute identifiers to list of valid descendants identifiers. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# validDescendants + +Map of attribute identifiers to list of valid descendants identifiers. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Map of attribute identifiers to list of valid descendants identifiers. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[any_string_name](#any_string_name)** | list, tuple, | tuple, | any string name can be used but the value must be the correct type Map of attribute identifiers to list of valid descendants identifiers. | [optional] + +# any_string_name + +Map of attribute identifiers to list of valid descendants identifiers. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Map of attribute identifiers to list of valid descendants identifiers. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AfmObjectIdentifierAttribute**](AfmObjectIdentifierAttribute.md) | [**AfmObjectIdentifierAttribute**](AfmObjectIdentifierAttribute.md) | [**AfmObjectIdentifierAttribute**](AfmObjectIdentifierAttribute.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AlertAfm.md b/gooddata-api-client/docs/models/AlertAfm.md new file mode 100644 index 000000000..93098dd38 --- /dev/null +++ b/gooddata-api-client/docs/models/AlertAfm.md @@ -0,0 +1,74 @@ +# gooddata_api_client.model.alert_afm.AlertAfm + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[measures](#measures)** | list, tuple, | tuple, | Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other. | +**[filters](#filters)** | list, tuple, | tuple, | Various filter types to filter execution result. For anomaly detection, exactly one dataset is specified in the condition. The AFM may contain multiple date filters for different datasets, but only the date filter matching the dataset from the condition is used for anomaly detection. | +**[attributes](#attributes)** | list, tuple, | tuple, | Attributes to be used in the computation. | [optional] +**[auxMeasures](#auxMeasures)** | list, tuple, | tuple, | Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# filters + +Various filter types to filter execution result. For anomaly detection, exactly one dataset is specified in the condition. The AFM may contain multiple date filters for different datasets, but only the date filter matching the dataset from the condition is used for anomaly detection. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Various filter types to filter execution result. For anomaly detection, exactly one dataset is specified in the condition. The AFM may contain multiple date filters for different datasets, but only the date filter matching the dataset from the condition is used for anomaly detection. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**FilterDefinition**](FilterDefinition.md) | [**FilterDefinition**](FilterDefinition.md) | [**FilterDefinition**](FilterDefinition.md) | | + +# measures + +Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | | + +# attributes + +Attributes to be used in the computation. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Attributes to be used in the computation. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AttributeItem**](AttributeItem.md) | [**AttributeItem**](AttributeItem.md) | [**AttributeItem**](AttributeItem.md) | | + +# auxMeasures + +Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AlertCondition.md b/gooddata-api-client/docs/models/AlertCondition.md new file mode 100644 index 000000000..5bef0f01d --- /dev/null +++ b/gooddata-api-client/docs/models/AlertCondition.md @@ -0,0 +1,20 @@ +# gooddata_api_client.model.alert_condition.AlertCondition + +Alert trigger condition. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Alert trigger condition. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[ComparisonWrapper](ComparisonWrapper.md) | [**ComparisonWrapper**](ComparisonWrapper.md) | [**ComparisonWrapper**](ComparisonWrapper.md) | | +[RangeWrapper](RangeWrapper.md) | [**RangeWrapper**](RangeWrapper.md) | [**RangeWrapper**](RangeWrapper.md) | | +[RelativeWrapper](RelativeWrapper.md) | [**RelativeWrapper**](RelativeWrapper.md) | [**RelativeWrapper**](RelativeWrapper.md) | | +[AnomalyDetectionWrapper](AnomalyDetectionWrapper.md) | [**AnomalyDetectionWrapper**](AnomalyDetectionWrapper.md) | [**AnomalyDetectionWrapper**](AnomalyDetectionWrapper.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AlertConditionOperand.md b/gooddata-api-client/docs/models/AlertConditionOperand.md new file mode 100644 index 000000000..2a9d78380 --- /dev/null +++ b/gooddata-api-client/docs/models/AlertConditionOperand.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.alert_condition_operand.AlertConditionOperand + +Operand of the alert condition. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Operand of the alert condition. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[LocalIdentifier](LocalIdentifier.md) | [**LocalIdentifier**](LocalIdentifier.md) | [**LocalIdentifier**](LocalIdentifier.md) | | +[Value](Value.md) | [**Value**](Value.md) | [**Value**](Value.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AlertDescription.md b/gooddata-api-client/docs/models/AlertDescription.md new file mode 100644 index 000000000..849ae4e0b --- /dev/null +++ b/gooddata-api-client/docs/models/AlertDescription.md @@ -0,0 +1,41 @@ +# gooddata_api_client.model.alert_description.AlertDescription + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**condition** | str, | str, | | +**metric** | str, | str, | | +**attribute** | str, | str, | | [optional] +**[currentValues](#currentValues)** | list, tuple, | tuple, | | [optional] +**errorMessage** | str, | str, | | [optional] +**formattedThreshold** | str, | str, | | [optional] +**lowerThreshold** | decimal.Decimal, int, float, | decimal.Decimal, | | [optional] value must be a 64 bit float +**remainingAlertEvaluationCount** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer +**status** | str, | str, | | [optional] must be one of ["SUCCESS", "ERROR", "INTERNAL_ERROR", "TIMEOUT", ] +**threshold** | decimal.Decimal, int, float, | decimal.Decimal, | | [optional] value must be a 64 bit float +**totalValueCount** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer +**traceId** | str, | str, | | [optional] +**triggeredAt** | str, datetime, | str, | | [optional] value must conform to RFC-3339 date-time +**triggeredCount** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer +**upperThreshold** | decimal.Decimal, int, float, | decimal.Decimal, | | [optional] value must be a 64 bit float +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# currentValues + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AlertEvaluationRow**](AlertEvaluationRow.md) | [**AlertEvaluationRow**](AlertEvaluationRow.md) | [**AlertEvaluationRow**](AlertEvaluationRow.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AlertEvaluationRow.md b/gooddata-api-client/docs/models/AlertEvaluationRow.md new file mode 100644 index 000000000..f1704087b --- /dev/null +++ b/gooddata-api-client/docs/models/AlertEvaluationRow.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.alert_evaluation_row.AlertEvaluationRow + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**computedMetric** | [**MetricRecord**](MetricRecord.md) | [**MetricRecord**](MetricRecord.md) | | [optional] +**labelValue** | str, | str, | | [optional] +**primaryMetric** | [**MetricRecord**](MetricRecord.md) | [**MetricRecord**](MetricRecord.md) | | [optional] +**secondaryMetric** | [**MetricRecord**](MetricRecord.md) | [**MetricRecord**](MetricRecord.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AllTimeDateFilter.md b/gooddata-api-client/docs/models/AllTimeDateFilter.md new file mode 100644 index 000000000..24028a476 --- /dev/null +++ b/gooddata-api-client/docs/models/AllTimeDateFilter.md @@ -0,0 +1,34 @@ +# gooddata_api_client.model.all_time_date_filter.AllTimeDateFilter + +An all-time date filter that does not restrict by date range. Controls how rows with empty (null/missing) date values are handled. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | An all-time date filter that does not restrict by date range. Controls how rows with empty (null/missing) date values are handled. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[allTimeDateFilter](#allTimeDateFilter)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# allTimeDateFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**dataset** | [**AfmObjectIdentifierDataset**](AfmObjectIdentifierDataset.md) | [**AfmObjectIdentifierDataset**](AfmObjectIdentifierDataset.md) | | +**applyOnResult** | bool, | BoolClass, | | [optional] +**emptyValueHandling** | str, | str, | Specifies how rows with empty (null/missing) date values should be handled. INCLUDE means no filtering effect (default), EXCLUDE removes rows with null dates, ONLY keeps only rows with null dates. | [optional] must be one of ["INCLUDE", "EXCLUDE", "ONLY", ] if omitted the server will use the default value of "INCLUDE" +**granularity** | str, | str, | Date granularity used to resolve the date attribute label for null value checks. Defaults to DAY if not specified. | [optional] must be one of ["MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR", ] if omitted the server will use the default value of "DAY" +**localIdentifier** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AllowedRelationshipType.md b/gooddata-api-client/docs/models/AllowedRelationshipType.md new file mode 100644 index 000000000..121efa8f2 --- /dev/null +++ b/gooddata-api-client/docs/models/AllowedRelationshipType.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.allowed_relationship_type.AllowedRelationshipType + +Allowed relationship type combination. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Allowed relationship type combination. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**sourceType** | str, | str, | Source object type (e.g., 'dashboard', 'visualization', 'metric'). | must be one of ["attribute", "metric", "fact", "label", "date", "dataset", "visualization", "dashboard", ] +**targetType** | str, | str, | Target object type (e.g., 'visualization', 'metric', 'attribute'). | must be one of ["attribute", "metric", "fact", "label", "date", "dataset", "visualization", "dashboard", ] +**allowOrphans** | bool, | BoolClass, | 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** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AnalyticsCatalogCreatedBy.md b/gooddata-api-client/docs/models/AnalyticsCatalogCreatedBy.md new file mode 100644 index 000000000..7e0401dd8 --- /dev/null +++ b/gooddata-api-client/docs/models/AnalyticsCatalogCreatedBy.md @@ -0,0 +1,30 @@ +# gooddata_api_client.model.analytics_catalog_created_by.AnalyticsCatalogCreatedBy + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**reasoning** | str, | str, | Reasoning for error states | +**[users](#users)** | list, tuple, | tuple, | Users who created any object in the catalog | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# users + +Users who created any object in the catalog + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Users who created any object in the catalog | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AnalyticsCatalogUser**](AnalyticsCatalogUser.md) | [**AnalyticsCatalogUser**](AnalyticsCatalogUser.md) | [**AnalyticsCatalogUser**](AnalyticsCatalogUser.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AnalyticsCatalogTags.md b/gooddata-api-client/docs/models/AnalyticsCatalogTags.md new file mode 100644 index 000000000..1c66bc11e --- /dev/null +++ b/gooddata-api-client/docs/models/AnalyticsCatalogTags.md @@ -0,0 +1,27 @@ +# gooddata_api_client.model.analytics_catalog_tags.AnalyticsCatalogTags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[tags](#tags)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Tags assigned to any object in the catalog | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AnalyticsCatalogUser.md b/gooddata-api-client/docs/models/AnalyticsCatalogUser.md new file mode 100644 index 000000000..42933bbeb --- /dev/null +++ b/gooddata-api-client/docs/models/AnalyticsCatalogUser.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.analytics_catalog_user.AnalyticsCatalogUser + +Users who created any object in the catalog + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Users who created any object in the catalog | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**firstname** | str, | str, | First name of the user who created any objects | +**userId** | str, | str, | User ID of the user who created any objects | +**lastname** | str, | str, | Last name of the user who created any objects | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AnomalyDetection.md b/gooddata-api-client/docs/models/AnomalyDetection.md new file mode 100644 index 000000000..2517779a5 --- /dev/null +++ b/gooddata-api-client/docs/models/AnomalyDetection.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.anomaly_detection.AnomalyDetection + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**measure** | [**LocalIdentifier**](LocalIdentifier.md) | [**LocalIdentifier**](LocalIdentifier.md) | | +**granularity** | str, | str, | Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR). | must be one of ["HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", ] +**sensitivity** | str, | str, | Sensitivity level for anomaly detection | must be one of ["LOW", "MEDIUM", "HIGH", ] +**dataset** | [**AfmObjectIdentifierDataset**](AfmObjectIdentifierDataset.md) | [**AfmObjectIdentifierDataset**](AfmObjectIdentifierDataset.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AnomalyDetectionConfig.md b/gooddata-api-client/docs/models/AnomalyDetectionConfig.md new file mode 100644 index 000000000..07ca0860a --- /dev/null +++ b/gooddata-api-client/docs/models/AnomalyDetectionConfig.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.anomaly_detection_config.AnomalyDetectionConfig + +Anomaly detection configuration. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Anomaly detection configuration. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**sensitivity** | str, | str, | Outlier sensitivity level. | must be one of ["LOW", "MEDIUM", "HIGH", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AnomalyDetectionRequest.md b/gooddata-api-client/docs/models/AnomalyDetectionRequest.md new file mode 100644 index 000000000..b96fe3139 --- /dev/null +++ b/gooddata-api-client/docs/models/AnomalyDetectionRequest.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.anomaly_detection_request.AnomalyDetectionRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**sensitivity** | decimal.Decimal, int, float, | decimal.Decimal, | Anomaly detection sensitivity. | value must be a 32 bit float +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AnomalyDetectionResult.md b/gooddata-api-client/docs/models/AnomalyDetectionResult.md new file mode 100644 index 000000000..dbe7ae733 --- /dev/null +++ b/gooddata-api-client/docs/models/AnomalyDetectionResult.md @@ -0,0 +1,53 @@ +# gooddata_api_client.model.anomaly_detection_result.AnomalyDetectionResult + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[values](#values)** | list, tuple, | tuple, | | +**[anomalyFlag](#anomalyFlag)** | list, tuple, | tuple, | | +**[attribute](#attribute)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# anomalyFlag + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | None, bool, | NoneClass, BoolClass, | | + +# attribute + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# values + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | None, decimal.Decimal, int, float, | NoneClass, decimal.Decimal, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AnomalyDetectionWrapper.md b/gooddata-api-client/docs/models/AnomalyDetectionWrapper.md new file mode 100644 index 000000000..270f9ca22 --- /dev/null +++ b/gooddata-api-client/docs/models/AnomalyDetectionWrapper.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.anomaly_detection_wrapper.AnomalyDetectionWrapper + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**anomaly** | [**AnomalyDetection**](AnomalyDetection.md) | [**AnomalyDetection**](AnomalyDetection.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ArithmeticMeasure.md b/gooddata-api-client/docs/models/ArithmeticMeasure.md new file mode 100644 index 000000000..fdc4e5c27 --- /dev/null +++ b/gooddata-api-client/docs/models/ArithmeticMeasure.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.arithmetic_measure.ArithmeticMeasure + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**left** | [**LocalIdentifier**](LocalIdentifier.md) | [**LocalIdentifier**](LocalIdentifier.md) | | +**right** | [**LocalIdentifier**](LocalIdentifier.md) | [**LocalIdentifier**](LocalIdentifier.md) | | +**operator** | str, | str, | Arithmetic operator. DIFFERENCE - m₁−m₂ - the difference between two metrics. CHANGE - (m₁−m₂)÷m₂ - the relative difference between two metrics. | must be one of ["DIFFERENCE", "CHANGE", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Array.md b/gooddata-api-client/docs/models/Array.md new file mode 100644 index 000000000..0178c13c9 --- /dev/null +++ b/gooddata-api-client/docs/models/Array.md @@ -0,0 +1,14 @@ +# gooddata_api_client.model.array.Array + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AssigneeRule.md b/gooddata-api-client/docs/models/AssigneeRule.md new file mode 100644 index 000000000..9759626cb --- /dev/null +++ b/gooddata-api-client/docs/models/AssigneeRule.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.assignee_rule.AssigneeRule + +Identifier of an assignee rule. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Identifier of an assignee rule. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**type** | str, | str, | | must be one of ["allWorkspaceUsers", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AttributeElements.md b/gooddata-api-client/docs/models/AttributeElements.md new file mode 100644 index 000000000..0f4b5cfb6 --- /dev/null +++ b/gooddata-api-client/docs/models/AttributeElements.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.attribute_elements.AttributeElements + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AttributeElementsByRef](AttributeElementsByRef.md) | [**AttributeElementsByRef**](AttributeElementsByRef.md) | [**AttributeElementsByRef**](AttributeElementsByRef.md) | | +[AttributeElementsByValue](AttributeElementsByValue.md) | [**AttributeElementsByValue**](AttributeElementsByValue.md) | [**AttributeElementsByValue**](AttributeElementsByValue.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AttributeElementsByRef.md b/gooddata-api-client/docs/models/AttributeElementsByRef.md new file mode 100644 index 000000000..5184eec14 --- /dev/null +++ b/gooddata-api-client/docs/models/AttributeElementsByRef.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.attribute_elements_by_ref.AttributeElementsByRef + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[uris](#uris)** | list, tuple, | tuple, | List of attribute elements by reference | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# uris + +List of attribute elements by reference + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of attribute elements by reference | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | None, str, | NoneClass, str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AttributeElementsByValue.md b/gooddata-api-client/docs/models/AttributeElementsByValue.md new file mode 100644 index 000000000..06a500b3c --- /dev/null +++ b/gooddata-api-client/docs/models/AttributeElementsByValue.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.attribute_elements_by_value.AttributeElementsByValue + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[values](#values)** | list, tuple, | tuple, | List of attribute elements by value | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# values + +List of attribute elements by value + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of attribute elements by value | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | None, str, | NoneClass, str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AttributeFilterByDate.md b/gooddata-api-client/docs/models/AttributeFilterByDate.md new file mode 100644 index 000000000..03e6099c8 --- /dev/null +++ b/gooddata-api-client/docs/models/AttributeFilterByDate.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.attribute_filter_by_date.AttributeFilterByDate + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**filterLocalIdentifier** | str, | str, | | +**isCommonDate** | bool, | BoolClass, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AttributeFilterParent.md b/gooddata-api-client/docs/models/AttributeFilterParent.md new file mode 100644 index 000000000..fb282dabf --- /dev/null +++ b/gooddata-api-client/docs/models/AttributeFilterParent.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.attribute_filter_parent.AttributeFilterParent + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**over** | [**Over**](Over.md) | [**Over**](Over.md) | | +**filterLocalIdentifier** | str, | str, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AttributeHeader.md b/gooddata-api-client/docs/models/AttributeHeader.md new file mode 100644 index 000000000..4c8523ac2 --- /dev/null +++ b/gooddata-api-client/docs/models/AttributeHeader.md @@ -0,0 +1,37 @@ +# gooddata_api_client.model.attribute_header.AttributeHeader + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributeHeader](#attributeHeader)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributeHeader + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**primaryLabel** | [**RestApiIdentifier**](RestApiIdentifier.md) | [**RestApiIdentifier**](RestApiIdentifier.md) | | +**localIdentifier** | str, | str, | Local identifier of the attribute this header relates to. | +**attributeName** | str, | str, | Attribute name. | +**attribute** | [**RestApiIdentifier**](RestApiIdentifier.md) | [**RestApiIdentifier**](RestApiIdentifier.md) | | +**label** | [**RestApiIdentifier**](RestApiIdentifier.md) | [**RestApiIdentifier**](RestApiIdentifier.md) | | +**labelName** | str, | str, | Label name. | +**format** | [**AttributeFormat**](AttributeFormat.md) | [**AttributeFormat**](AttributeFormat.md) | | [optional] +**geoAreaConfig** | [**GeoAreaConfig**](GeoAreaConfig.md) | [**GeoAreaConfig**](GeoAreaConfig.md) | | [optional] +**granularity** | str, | str, | Date granularity of the attribute, only filled for date attributes. | [optional] must be one of ["MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR", ] +**valueType** | str, | str, | Attribute value type. | [optional] must be one of ["TEXT", "HYPERLINK", "GEO", "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", "IMAGE", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AttributeNegativeFilter.md b/gooddata-api-client/docs/models/AttributeNegativeFilter.md new file mode 100644 index 000000000..cc40bdaa0 --- /dev/null +++ b/gooddata-api-client/docs/models/AttributeNegativeFilter.md @@ -0,0 +1,42 @@ +# gooddata_api_client.model.attribute_negative_filter.AttributeNegativeFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[Filter](Filter.md) | [**Filter**](Filter.md) | [**Filter**](Filter.md) | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[exclude](#exclude)** | list, tuple, | tuple, | | [optional] +**using** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# exclude + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AttributePositiveFilter.md b/gooddata-api-client/docs/models/AttributePositiveFilter.md new file mode 100644 index 000000000..7bd270520 --- /dev/null +++ b/gooddata-api-client/docs/models/AttributePositiveFilter.md @@ -0,0 +1,42 @@ +# gooddata_api_client.model.attribute_positive_filter.AttributePositiveFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[Filter](Filter.md) | [**Filter**](Filter.md) | [**Filter**](Filter.md) | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[include](#include)** | list, tuple, | tuple, | | [optional] +**using** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# include + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AutomationAlert.md b/gooddata-api-client/docs/models/AutomationAlert.md new file mode 100644 index 000000000..3b1eaea0e --- /dev/null +++ b/gooddata-api-client/docs/models/AutomationAlert.md @@ -0,0 +1,34 @@ +# gooddata_api_client.model.automation_alert.AutomationAlert + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**execution** | [**AlertAfm**](AlertAfm.md) | [**AlertAfm**](AlertAfm.md) | | +**[condition](#condition)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +**interval** | str, | str, | Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR. | [optional] must be one of ["DAY", "WEEK", "MONTH", "QUARTER", "YEAR", ] +**trigger** | str, | 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] must be one of ["ALWAYS", "ONCE", "ONCE_PER_INTERVAL", ] if omitted the server will use the default value of "ALWAYS" +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# condition + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AnomalyDetectionWrapper](AnomalyDetectionWrapper.md) | [**AnomalyDetectionWrapper**](AnomalyDetectionWrapper.md) | [**AnomalyDetectionWrapper**](AnomalyDetectionWrapper.md) | | +[ComparisonWrapper](ComparisonWrapper.md) | [**ComparisonWrapper**](ComparisonWrapper.md) | [**ComparisonWrapper**](ComparisonWrapper.md) | | +[RangeWrapper](RangeWrapper.md) | [**RangeWrapper**](RangeWrapper.md) | [**RangeWrapper**](RangeWrapper.md) | | +[RelativeWrapper](RelativeWrapper.md) | [**RelativeWrapper**](RelativeWrapper.md) | [**RelativeWrapper**](RelativeWrapper.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AutomationDashboardTabularExport.md b/gooddata-api-client/docs/models/AutomationDashboardTabularExport.md new file mode 100644 index 000000000..bafbdb9f0 --- /dev/null +++ b/gooddata-api-client/docs/models/AutomationDashboardTabularExport.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.automation_dashboard_tabular_export.AutomationDashboardTabularExport + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**DashboardTabularExportRequestV2**](DashboardTabularExportRequestV2.md) | [**DashboardTabularExportRequestV2**](DashboardTabularExportRequestV2.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AutomationExternalRecipient.md b/gooddata-api-client/docs/models/AutomationExternalRecipient.md new file mode 100644 index 000000000..f0fea9b84 --- /dev/null +++ b/gooddata-api-client/docs/models/AutomationExternalRecipient.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.automation_external_recipient.AutomationExternalRecipient + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**email** | str, | str, | E-mail address to send notifications from. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AutomationImageExport.md b/gooddata-api-client/docs/models/AutomationImageExport.md new file mode 100644 index 000000000..c52107c0e --- /dev/null +++ b/gooddata-api-client/docs/models/AutomationImageExport.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.automation_image_export.AutomationImageExport + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**ImageExportRequest**](ImageExportRequest.md) | [**ImageExportRequest**](ImageExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AutomationMetadata.md b/gooddata-api-client/docs/models/AutomationMetadata.md new file mode 100644 index 000000000..25653289a --- /dev/null +++ b/gooddata-api-client/docs/models/AutomationMetadata.md @@ -0,0 +1,30 @@ +# gooddata_api_client.model.automation_metadata.AutomationMetadata + +Additional information for the automation. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Additional information for the automation. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[visibleFilters](#visibleFilters)** | list, tuple, | tuple, | | [optional] +**widget** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# visibleFilters + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**VisibleFilter**](VisibleFilter.md) | [**VisibleFilter**](VisibleFilter.md) | [**VisibleFilter**](VisibleFilter.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AutomationNotification.md b/gooddata-api-client/docs/models/AutomationNotification.md new file mode 100644 index 000000000..275187b41 --- /dev/null +++ b/gooddata-api-client/docs/models/AutomationNotification.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.automation_notification.AutomationNotification + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[NotificationContent](NotificationContent.md) | [**NotificationContent**](NotificationContent.md) | [**NotificationContent**](NotificationContent.md) | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**content** | [**WebhookMessage**](WebhookMessage.md) | [**WebhookMessage**](WebhookMessage.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AutomationRawExport.md b/gooddata-api-client/docs/models/AutomationRawExport.md new file mode 100644 index 000000000..762a0d47b --- /dev/null +++ b/gooddata-api-client/docs/models/AutomationRawExport.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.automation_raw_export.AutomationRawExport + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**RawExportAutomationRequest**](RawExportAutomationRequest.md) | [**RawExportAutomationRequest**](RawExportAutomationRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AutomationSchedule.md b/gooddata-api-client/docs/models/AutomationSchedule.md new file mode 100644 index 000000000..20c2ac3da --- /dev/null +++ b/gooddata-api-client/docs/models/AutomationSchedule.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.automation_schedule.AutomationSchedule + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**cron** | str, | str, | 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. | +**timezone** | str, | str, | Timezone in which the schedule is defined. | +**cronDescription** | str, | str, | Human-readable description of the cron expression. | [optional] +**firstRun** | str, datetime, | str, | Timestamp of the first scheduled action. If not provided default to the next scheduled time. | [optional] value must conform to RFC-3339 date-time +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AutomationSlidesExport.md b/gooddata-api-client/docs/models/AutomationSlidesExport.md new file mode 100644 index 000000000..11133c389 --- /dev/null +++ b/gooddata-api-client/docs/models/AutomationSlidesExport.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.automation_slides_export.AutomationSlidesExport + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**SlidesExportRequest**](SlidesExportRequest.md) | [**SlidesExportRequest**](SlidesExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AutomationTabularExport.md b/gooddata-api-client/docs/models/AutomationTabularExport.md new file mode 100644 index 000000000..ccc542078 --- /dev/null +++ b/gooddata-api-client/docs/models/AutomationTabularExport.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.automation_tabular_export.AutomationTabularExport + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**TabularExportRequest**](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AutomationVisualExport.md b/gooddata-api-client/docs/models/AutomationVisualExport.md new file mode 100644 index 000000000..749e19b6e --- /dev/null +++ b/gooddata-api-client/docs/models/AutomationVisualExport.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.automation_visual_export.AutomationVisualExport + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**VisualExportRequest**](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AwsBedrockAccessKeyAuth.md b/gooddata-api-client/docs/models/AwsBedrockAccessKeyAuth.md new file mode 100644 index 000000000..e4a69ae2c --- /dev/null +++ b/gooddata-api-client/docs/models/AwsBedrockAccessKeyAuth.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.aws_bedrock_access_key_auth.AwsBedrockAccessKeyAuth + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**accessKeyId** | None, str, | NoneClass, str, | AWS Access Key ID. | [optional] +**secretAccessKey** | None, str, | NoneClass, str, | AWS Secret Access Key. | [optional] +**sessionToken** | None, str, | NoneClass, str, | AWS Session Token (for temporary credentials). | [optional] +**type** | str, | str, | Authentication type. | [optional] must be one of ["ACCESS_KEY", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AwsBedrockProviderConfig.md b/gooddata-api-client/docs/models/AwsBedrockProviderConfig.md new file mode 100644 index 000000000..19eb228f5 --- /dev/null +++ b/gooddata-api-client/docs/models/AwsBedrockProviderConfig.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.aws_bedrock_provider_config.AwsBedrockProviderConfig + +Configuration for AWS Bedrock provider. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Configuration for AWS Bedrock provider. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**auth** | [**BedrockProviderAuth**](BedrockProviderAuth.md) | [**BedrockProviderAuth**](BedrockProviderAuth.md) | | +**region** | str, | str, | AWS region for Bedrock. | +**type** | str, | str, | Provider type. | must be one of ["AWS_BEDROCK", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AzureFoundryApiKeyAuth.md b/gooddata-api-client/docs/models/AzureFoundryApiKeyAuth.md new file mode 100644 index 000000000..659e075f5 --- /dev/null +++ b/gooddata-api-client/docs/models/AzureFoundryApiKeyAuth.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.azure_foundry_api_key_auth.AzureFoundryApiKeyAuth + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**apiKey** | None, str, | NoneClass, str, | Azure API key. | [optional] +**type** | str, | str, | Authentication type. | [optional] must be one of ["API_KEY", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AzureFoundryProviderAuth.md b/gooddata-api-client/docs/models/AzureFoundryProviderAuth.md new file mode 100644 index 000000000..3aa963da9 --- /dev/null +++ b/gooddata-api-client/docs/models/AzureFoundryProviderAuth.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.azure_foundry_provider_auth.AzureFoundryProviderAuth + +Authentication configuration. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Authentication configuration. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AzureFoundryApiKeyAuth](AzureFoundryApiKeyAuth.md) | [**AzureFoundryApiKeyAuth**](AzureFoundryApiKeyAuth.md) | [**AzureFoundryApiKeyAuth**](AzureFoundryApiKeyAuth.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/AzureFoundryProviderConfig.md b/gooddata-api-client/docs/models/AzureFoundryProviderConfig.md new file mode 100644 index 000000000..662414023 --- /dev/null +++ b/gooddata-api-client/docs/models/AzureFoundryProviderConfig.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.azure_foundry_provider_config.AzureFoundryProviderConfig + +Configuration for Azure Foundry provider. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Configuration for Azure Foundry provider. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**endpoint** | str, | str, | Azure AI inference endpoint URL. | +**auth** | [**AzureFoundryProviderAuth**](AzureFoundryProviderAuth.md) | [**AzureFoundryProviderAuth**](AzureFoundryProviderAuth.md) | | +**type** | str, | str, | Provider type. | must be one of ["AZURE_FOUNDRY", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/BedrockProviderAuth.md b/gooddata-api-client/docs/models/BedrockProviderAuth.md new file mode 100644 index 000000000..2e224ac0d --- /dev/null +++ b/gooddata-api-client/docs/models/BedrockProviderAuth.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.bedrock_provider_auth.BedrockProviderAuth + +Authentication configuration. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Authentication configuration. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AwsBedrockAccessKeyAuth](AwsBedrockAccessKeyAuth.md) | [**AwsBedrockAccessKeyAuth**](AwsBedrockAccessKeyAuth.md) | [**AwsBedrockAccessKeyAuth**](AwsBedrockAccessKeyAuth.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/BoundedFilter.md b/gooddata-api-client/docs/models/BoundedFilter.md new file mode 100644 index 000000000..afadfded5 --- /dev/null +++ b/gooddata-api-client/docs/models/BoundedFilter.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.bounded_filter.BoundedFilter + +Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**granularity** | str, | str, | Date granularity specifying particular date attribute in given dimension. | must be one of ["MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR", ] +**from** | None, decimal.Decimal, int, | NoneClass, decimal.Decimal, | 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'). If null, then start of the range is unbounded. | [optional] value must be a 32 bit integer +**to** | None, decimal.Decimal, int, | NoneClass, decimal.Decimal, | 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, ...). If null, then end of the range is unbounded. | [optional] value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ChangeAnalysisParams.md b/gooddata-api-client/docs/models/ChangeAnalysisParams.md new file mode 100644 index 000000000..e8723d2db --- /dev/null +++ b/gooddata-api-client/docs/models/ChangeAnalysisParams.md @@ -0,0 +1,67 @@ +# gooddata_api_client.model.change_analysis_params.ChangeAnalysisParams + +Change analysis specification. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Change analysis specification. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**measureTitle** | str, | str, | The title of the measure being analyzed | +**measure** | [**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | | +**referencePeriod** | str, | str, | The reference time period | +**[attributes](#attributes)** | list, tuple, | tuple, | Attributes to analyze for significant changes | +**analyzedPeriod** | str, | str, | The analyzed time period | +**[filters](#filters)** | list, tuple, | tuple, | Optional filters to apply | +**useSmartAttributeSelection** | bool, | BoolClass, | Whether to use smart attribute selection | +**dateAttribute** | [**AttributeItem**](AttributeItem.md) | [**AttributeItem**](AttributeItem.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +Attributes to analyze for significant changes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Attributes to analyze for significant changes | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AttributeItem**](AttributeItem.md) | [**AttributeItem**](AttributeItem.md) | [**AttributeItem**](AttributeItem.md) | | + +# filters + +Optional filters to apply + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Optional filters to apply | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AbstractMeasureValueFilter](AbstractMeasureValueFilter.md) | [**AbstractMeasureValueFilter**](AbstractMeasureValueFilter.md) | [**AbstractMeasureValueFilter**](AbstractMeasureValueFilter.md) | | +[FilterDefinitionForSimpleMeasure](FilterDefinitionForSimpleMeasure.md) | [**FilterDefinitionForSimpleMeasure**](FilterDefinitionForSimpleMeasure.md) | [**FilterDefinitionForSimpleMeasure**](FilterDefinitionForSimpleMeasure.md) | | +[InlineFilterDefinition](InlineFilterDefinition.md) | [**InlineFilterDefinition**](InlineFilterDefinition.md) | [**InlineFilterDefinition**](InlineFilterDefinition.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ChangeAnalysisRequest.md b/gooddata-api-client/docs/models/ChangeAnalysisRequest.md new file mode 100644 index 000000000..1bbfb153f --- /dev/null +++ b/gooddata-api-client/docs/models/ChangeAnalysisRequest.md @@ -0,0 +1,111 @@ +# gooddata_api_client.model.change_analysis_request.ChangeAnalysisRequest + +Request for change analysis computation + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Request for change analysis computation | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**measure** | [**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | | +**referencePeriod** | str, | str, | The reference time period (e.g., '2025-01') | +**analyzedPeriod** | str, | str, | The analyzed time period (e.g., '2025-02') | +**dateAttribute** | [**AttributeItem**](AttributeItem.md) | [**AttributeItem**](AttributeItem.md) | | +**[attributes](#attributes)** | list, tuple, | tuple, | Attributes to analyze for significant changes. If empty, valid attributes will be automatically discovered. | [optional] +**[auxMeasures](#auxMeasures)** | list, tuple, | tuple, | Auxiliary measures | [optional] +**[excludeTags](#excludeTags)** | list, tuple, | tuple, | Exclude attributes with any of these tags. This filter applies to both auto-discovered and explicitly provided attributes. | [optional] +**[filters](#filters)** | list, tuple, | tuple, | Optional filters to apply. | [optional] +**[includeTags](#includeTags)** | list, tuple, | tuple, | Only include attributes with at least one of these tags. If empty, no inclusion filter is applied. This filter applies to both auto-discovered and explicitly provided attributes. | [optional] +**useSmartAttributeSelection** | bool, | BoolClass, | Whether to use smart attribute selection (LLM-based) instead of discovering all valid attributes. If true, GenAI will intelligently select the most relevant attributes for change analysis. If false or not set, all valid attributes will be discovered using Calcique. Smart attribute selection applies only when no attributes are provided. | [optional] if omitted the server will use the default value of False +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +Attributes to analyze for significant changes. If empty, valid attributes will be automatically discovered. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Attributes to analyze for significant changes. If empty, valid attributes will be automatically discovered. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AttributeItem**](AttributeItem.md) | [**AttributeItem**](AttributeItem.md) | [**AttributeItem**](AttributeItem.md) | | + +# auxMeasures + +Auxiliary measures + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Auxiliary measures | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | | + +# excludeTags + +Exclude attributes with any of these tags. This filter applies to both auto-discovered and explicitly provided attributes. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Exclude attributes with any of these tags. This filter applies to both auto-discovered and explicitly provided attributes. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Exclude attributes with any of these tags. This filter applies to both auto-discovered and explicitly provided attributes. | + +# filters + +Optional filters to apply. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Optional filters to apply. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AbstractMeasureValueFilter](AbstractMeasureValueFilter.md) | [**AbstractMeasureValueFilter**](AbstractMeasureValueFilter.md) | [**AbstractMeasureValueFilter**](AbstractMeasureValueFilter.md) | | +[FilterDefinitionForSimpleMeasure](FilterDefinitionForSimpleMeasure.md) | [**FilterDefinitionForSimpleMeasure**](FilterDefinitionForSimpleMeasure.md) | [**FilterDefinitionForSimpleMeasure**](FilterDefinitionForSimpleMeasure.md) | | +[InlineFilterDefinition](InlineFilterDefinition.md) | [**InlineFilterDefinition**](InlineFilterDefinition.md) | [**InlineFilterDefinition**](InlineFilterDefinition.md) | | + +# includeTags + +Only include attributes with at least one of these tags. If empty, no inclusion filter is applied. This filter applies to both auto-discovered and explicitly provided attributes. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Only include attributes with at least one of these tags. If empty, no inclusion filter is applied. This filter applies to both auto-discovered and explicitly provided attributes. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Only include attributes with at least one of these tags. If empty, no inclusion filter is applied. This filter applies to both auto-discovered and explicitly provided attributes. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ChangeAnalysisResponse.md b/gooddata-api-client/docs/models/ChangeAnalysisResponse.md new file mode 100644 index 000000000..5162e61df --- /dev/null +++ b/gooddata-api-client/docs/models/ChangeAnalysisResponse.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.change_analysis_response.ChangeAnalysisResponse + +Response for change analysis computation + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Response for change analysis computation | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**links** | [**ExecutionLinks**](ExecutionLinks.md) | [**ExecutionLinks**](ExecutionLinks.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ChangeAnalysisResult.md b/gooddata-api-client/docs/models/ChangeAnalysisResult.md new file mode 100644 index 000000000..4df8cf9f3 --- /dev/null +++ b/gooddata-api-client/docs/models/ChangeAnalysisResult.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.change_analysis_result.ChangeAnalysisResult + +Result of a change analysis execution. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Result of a change analysis execution. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | The change analysis result data containing significant changes. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +The change analysis result data containing significant changes. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | The change analysis result data containing significant changes. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**MetricValueChange**](MetricValueChange.md) | [**MetricValueChange**](MetricValueChange.md) | [**MetricValueChange**](MetricValueChange.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ChatHistoryInteraction.md b/gooddata-api-client/docs/models/ChatHistoryInteraction.md new file mode 100644 index 000000000..345c15d10 --- /dev/null +++ b/gooddata-api-client/docs/models/ChatHistoryInteraction.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.chat_history_interaction.ChatHistoryInteraction + +List of chat history interactions. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | List of chat history interactions. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**routing** | [**RouteResult**](RouteResult.md) | [**RouteResult**](RouteResult.md) | | +**question** | str, | str, | User question | +**chatHistoryInteractionId** | str, | str, | Chat History interaction ID. Unique ID for each interaction. | +**interactionFinished** | bool, | BoolClass, | Has the interaction already finished? Can be used for polling when interaction is in progress. | +**changeAnalysisParams** | [**ChangeAnalysisParams**](ChangeAnalysisParams.md) | [**ChangeAnalysisParams**](ChangeAnalysisParams.md) | | [optional] +**createdVisualizations** | [**CreatedVisualizations**](CreatedVisualizations.md) | [**CreatedVisualizations**](CreatedVisualizations.md) | | [optional] +**errorResponse** | str, | str, | Error response in anything fails. | [optional] +**foundObjects** | [**FoundObjects**](FoundObjects.md) | [**FoundObjects**](FoundObjects.md) | | [optional] +**reasoning** | [**Reasoning**](Reasoning.md) | [**Reasoning**](Reasoning.md) | | [optional] +**semanticSearch** | [**SearchResult**](SearchResult.md) | [**SearchResult**](SearchResult.md) | | [optional] +**textResponse** | str, | str, | Text response for general questions. | [optional] +**threadIdSuffix** | str, | str, | Chat History thread suffix appended to ID generated by backend. Enables more chat windows. | [optional] +**userFeedback** | str, | str, | User feedback. | [optional] must be one of ["POSITIVE", "NEGATIVE", "NONE", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ChatHistoryRequest.md b/gooddata-api-client/docs/models/ChatHistoryRequest.md new file mode 100644 index 000000000..66e2140f3 --- /dev/null +++ b/gooddata-api-client/docs/models/ChatHistoryRequest.md @@ -0,0 +1,21 @@ +# gooddata_api_client.model.chat_history_request.ChatHistoryRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**chatHistoryInteractionId** | str, | str, | Return chat history records only after this interaction ID. If empty, complete chat history is returned. | [optional] +**reset** | bool, | BoolClass, | User feedback. | [optional] +**responseState** | str, | str, | Response state indicating the outcome of the AI interaction. | [optional] must be one of ["SUCCESSFUL", "UNEXPECTED_ERROR", "NOT_FOUND_ATTRIBUTES", "TOO_MANY_DATA_POINTS", "NO_DATA", "NO_RESULTS", "OUT_OF_TOPIC", ] +**savedVisualization** | [**SavedVisualization**](SavedVisualization.md) | [**SavedVisualization**](SavedVisualization.md) | | [optional] +**threadIdSuffix** | str, | str, | Chat History thread suffix appended to ID generated by backend. Enables more chat windows. | [optional] +**userFeedback** | str, | str, | User feedback. | [optional] must be one of ["POSITIVE", "NEGATIVE", "NONE", ] +**userTextFeedback** | str, | str, | User text feedback for the interaction. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ChatHistoryResult.md b/gooddata-api-client/docs/models/ChatHistoryResult.md new file mode 100644 index 000000000..ebd490aec --- /dev/null +++ b/gooddata-api-client/docs/models/ChatHistoryResult.md @@ -0,0 +1,30 @@ +# gooddata_api_client.model.chat_history_result.ChatHistoryResult + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**threadId** | str, | str, | The conversation thread ID. | +**[interactions](#interactions)** | list, tuple, | tuple, | List of chat history interactions. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# interactions + +List of chat history interactions. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of chat history interactions. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ChatHistoryInteraction**](ChatHistoryInteraction.md) | [**ChatHistoryInteraction**](ChatHistoryInteraction.md) | [**ChatHistoryInteraction**](ChatHistoryInteraction.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ChatRequest.md b/gooddata-api-client/docs/models/ChatRequest.md new file mode 100644 index 000000000..98470cb95 --- /dev/null +++ b/gooddata-api-client/docs/models/ChatRequest.md @@ -0,0 +1,54 @@ +# gooddata_api_client.model.chat_request.ChatRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**question** | str, | str, | User question | +**[allowedRelationshipTypes](#allowedRelationshipTypes)** | list, tuple, | tuple, | 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] +**includeHidden** | bool, | BoolClass, | 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 +**limitCreate** | decimal.Decimal, int, | decimal.Decimal, | Maximum number of created results. | [optional] if omitted the server will use the default value of 3value must be a 32 bit integer +**limitCreateContext** | decimal.Decimal, int, | decimal.Decimal, | 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 10value must be a 32 bit integer +**limitSearch** | decimal.Decimal, int, | decimal.Decimal, | Maximum number of search results. | [optional] if omitted the server will use the default value of 5value must be a 32 bit integer +**[objectTypes](#objectTypes)** | list, tuple, | tuple, | List of object types to filter the search and visualization building. If empty or null, all object types are considered. | [optional] +**relevantScoreThreshold** | decimal.Decimal, int, float, | decimal.Decimal, | 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.45value must be a 64 bit float +**searchScoreThreshold** | decimal.Decimal, int, float, | decimal.Decimal, | 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.9value must be a 64 bit float +**threadIdSuffix** | str, | str, | Chat History thread suffix appended to ID generated by backend. Enables more chat windows. | [optional] +**titleToDescriptorRatio** | decimal.Decimal, int, float, | decimal.Decimal, | Temporary for experiments. Ratio of title score to descriptor score. | [optional] if omitted the server will use the default value of 0.7value must be a 64 bit float +**userContext** | [**UserContext**](UserContext.md) | [**UserContext**](UserContext.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# allowedRelationshipTypes + +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). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | 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). | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AllowedRelationshipType**](AllowedRelationshipType.md) | [**AllowedRelationshipType**](AllowedRelationshipType.md) | [**AllowedRelationshipType**](AllowedRelationshipType.md) | | + +# objectTypes + +List of object types to filter the search and visualization building. If empty or null, all object types are considered. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of object types to filter the search and visualization building. If empty or null, all object types are considered. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Object type to filter. | must be one of ["attribute", "metric", "fact", "label", "date", "dataset", "visualization", "dashboard", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ChatResult.md b/gooddata-api-client/docs/models/ChatResult.md new file mode 100644 index 000000000..019ee9f83 --- /dev/null +++ b/gooddata-api-client/docs/models/ChatResult.md @@ -0,0 +1,24 @@ +# gooddata_api_client.model.chat_result.ChatResult + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**changeAnalysisParams** | [**ChangeAnalysisParams**](ChangeAnalysisParams.md) | [**ChangeAnalysisParams**](ChangeAnalysisParams.md) | | [optional] +**chatHistoryInteractionId** | str, | str, | Chat History interaction ID. Unique ID for each interaction. | [optional] +**createdVisualizations** | [**CreatedVisualizations**](CreatedVisualizations.md) | [**CreatedVisualizations**](CreatedVisualizations.md) | | [optional] +**errorResponse** | str, | str, | Error response in anything fails. | [optional] +**foundObjects** | [**FoundObjects**](FoundObjects.md) | [**FoundObjects**](FoundObjects.md) | | [optional] +**reasoning** | [**Reasoning**](Reasoning.md) | [**Reasoning**](Reasoning.md) | | [optional] +**routing** | [**RouteResult**](RouteResult.md) | [**RouteResult**](RouteResult.md) | | [optional] +**semanticSearch** | [**SearchResult**](SearchResult.md) | [**SearchResult**](SearchResult.md) | | [optional] +**textResponse** | str, | str, | Text response for general questions. | [optional] +**threadIdSuffix** | str, | str, | Chat History thread suffix appended to ID generated by backend. Enables more chat windows. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ChatUsageResponse.md b/gooddata-api-client/docs/models/ChatUsageResponse.md new file mode 100644 index 000000000..32e19c5b0 --- /dev/null +++ b/gooddata-api-client/docs/models/ChatUsageResponse.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.chat_usage_response.ChatUsageResponse + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**interactionLimit** | decimal.Decimal, int, | decimal.Decimal, | Maximum number of interactions in the time window any user can do in the workspace | value must be a 32 bit integer +**timeWindowHours** | decimal.Decimal, int, | decimal.Decimal, | Time window in hours | value must be a 32 bit integer +**interactionCount** | decimal.Decimal, int, | decimal.Decimal, | Number of interactions in the time window | value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ClusteringConfig.md b/gooddata-api-client/docs/models/ClusteringConfig.md new file mode 100644 index 000000000..744c2921d --- /dev/null +++ b/gooddata-api-client/docs/models/ClusteringConfig.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.clustering_config.ClusteringConfig + +Clustering configuration. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Clustering configuration. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**numberOfClusters** | decimal.Decimal, int, | decimal.Decimal, | Number of clusters to create | value must be a 32 bit integer +**threshold** | decimal.Decimal, int, float, | decimal.Decimal, | Clustering algorithm threshold | value must be a 32 bit float +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ClusteringRequest.md b/gooddata-api-client/docs/models/ClusteringRequest.md new file mode 100644 index 000000000..89f3ef5f4 --- /dev/null +++ b/gooddata-api-client/docs/models/ClusteringRequest.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.clustering_request.ClusteringRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**numberOfClusters** | decimal.Decimal, int, | decimal.Decimal, | Number of clusters to create | value must be a 32 bit integer +**threshold** | decimal.Decimal, int, float, | decimal.Decimal, | Threshold used for algorithm | [optional] if omitted the server will use the default value of 0.03value must be a 64 bit float +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ClusteringResult.md b/gooddata-api-client/docs/models/ClusteringResult.md new file mode 100644 index 000000000..3ce528626 --- /dev/null +++ b/gooddata-api-client/docs/models/ClusteringResult.md @@ -0,0 +1,99 @@ +# gooddata_api_client.model.clustering_result.ClusteringResult + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[xcoord](#xcoord)** | list, tuple, | tuple, | | +**[attribute](#attribute)** | list, tuple, | tuple, | | +**[ycoord](#ycoord)** | list, tuple, | tuple, | | +**[clusters](#clusters)** | list, tuple, | tuple, | | +**[xCoord](#xCoord)** | list, tuple, | tuple, | | [optional] +**[yCoord](#yCoord)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attribute + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# clusters + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | None, decimal.Decimal, int, | NoneClass, decimal.Decimal, | | value must be a 32 bit integer + +# xcoord + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | decimal.Decimal, int, float, | decimal.Decimal, | | + +# ycoord + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | decimal.Decimal, int, float, | decimal.Decimal, | | + +# xCoord + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | None, decimal.Decimal, int, float, | NoneClass, decimal.Decimal, | | + +# yCoord + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | None, decimal.Decimal, int, float, | NoneClass, decimal.Decimal, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ColumnLocation.md b/gooddata-api-client/docs/models/ColumnLocation.md new file mode 100644 index 000000000..08efeb7d4 --- /dev/null +++ b/gooddata-api-client/docs/models/ColumnLocation.md @@ -0,0 +1,9 @@ +# gooddata_api_client.model.column_location.ColumnLocation + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ColumnOverride.md b/gooddata-api-client/docs/models/ColumnOverride.md new file mode 100644 index 000000000..7d92007d7 --- /dev/null +++ b/gooddata-api-client/docs/models/ColumnOverride.md @@ -0,0 +1,20 @@ +# gooddata_api_client.model.column_override.ColumnOverride + +Table column override. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Table column override. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**name** | str, | str, | Column name. | +**labelTargetColumn** | str, | str, | Specifies the attribute's column to which this label is associated. | [optional] +**labelType** | str, | str, | Label type for the target attribute. | [optional] must be one of ["TEXT", "HYPERLINK", "GEO", "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", "IMAGE", ] +**ldmTypeOverride** | str, | str, | Logical Data Model type for the column. | [optional] must be one of ["FACT", "LABEL", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ColumnStatistic.md b/gooddata-api-client/docs/models/ColumnStatistic.md new file mode 100644 index 000000000..1b62f61da --- /dev/null +++ b/gooddata-api-client/docs/models/ColumnStatistic.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.column_statistic.ColumnStatistic + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**type** | str, | str, | | must be one of ["COUNT", "COUNT_NULL", "COUNT_UNIQUE", "AVG", "STDDEV", "MIN", "MAX", "PERCENTILE_25", "PERCENTILE_50", "PERCENTILE_75", ] +**value** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ColumnStatisticWarning.md b/gooddata-api-client/docs/models/ColumnStatisticWarning.md new file mode 100644 index 000000000..5b7b15907 --- /dev/null +++ b/gooddata-api-client/docs/models/ColumnStatisticWarning.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.column_statistic_warning.ColumnStatisticWarning + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**action** | str, | str, | | +**message** | str, | str, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ColumnStatisticsRequest.md b/gooddata-api-client/docs/models/ColumnStatisticsRequest.md new file mode 100644 index 000000000..001649f1e --- /dev/null +++ b/gooddata-api-client/docs/models/ColumnStatisticsRequest.md @@ -0,0 +1,47 @@ +# gooddata_api_client.model.column_statistics_request.ColumnStatisticsRequest + +A request to retrieve statistics for a column. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A request to retrieve statistics for a column. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[from](#from)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +**columnName** | str, | str, | | +**frequency** | [**FrequencyProperties**](FrequencyProperties.md) | [**FrequencyProperties**](FrequencyProperties.md) | | [optional] +**histogram** | [**HistogramProperties**](HistogramProperties.md) | [**HistogramProperties**](HistogramProperties.md) | | [optional] +**[statistics](#statistics)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# from + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[SqlQuery](SqlQuery.md) | [**SqlQuery**](SqlQuery.md) | [**SqlQuery**](SqlQuery.md) | | +[Table](Table.md) | [**Table**](Table.md) | [**Table**](Table.md) | | + +# statistics + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["COUNT", "COUNT_NULL", "COUNT_UNIQUE", "AVG", "STDDEV", "MIN", "MAX", "PERCENTILE_25", "PERCENTILE_50", "PERCENTILE_75", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ColumnStatisticsResponse.md b/gooddata-api-client/docs/models/ColumnStatisticsResponse.md new file mode 100644 index 000000000..369c67ef5 --- /dev/null +++ b/gooddata-api-client/docs/models/ColumnStatisticsResponse.md @@ -0,0 +1,42 @@ +# gooddata_api_client.model.column_statistics_response.ColumnStatisticsResponse + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**frequency** | [**Frequency**](Frequency.md) | [**Frequency**](Frequency.md) | | [optional] +**histogram** | [**Histogram**](Histogram.md) | [**Histogram**](Histogram.md) | | [optional] +**[statistics](#statistics)** | list, tuple, | tuple, | | [optional] +**[warnings](#warnings)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# statistics + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ColumnStatistic**](ColumnStatistic.md) | [**ColumnStatistic**](ColumnStatistic.md) | [**ColumnStatistic**](ColumnStatistic.md) | | + +# warnings + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ColumnStatisticWarning**](ColumnStatisticWarning.md) | [**ColumnStatisticWarning**](ColumnStatisticWarning.md) | [**ColumnStatisticWarning**](ColumnStatisticWarning.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Comparison.md b/gooddata-api-client/docs/models/Comparison.md new file mode 100644 index 000000000..b2596d5e6 --- /dev/null +++ b/gooddata-api-client/docs/models/Comparison.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.comparison.Comparison + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**left** | [**LocalIdentifier**](LocalIdentifier.md) | [**LocalIdentifier**](LocalIdentifier.md) | | +**right** | [**AlertConditionOperand**](AlertConditionOperand.md) | [**AlertConditionOperand**](AlertConditionOperand.md) | | +**operator** | str, | str, | | must be one of ["GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ComparisonCondition.md b/gooddata-api-client/docs/models/ComparisonCondition.md new file mode 100644 index 000000000..71fc07bb6 --- /dev/null +++ b/gooddata-api-client/docs/models/ComparisonCondition.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.comparison_condition.ComparisonCondition + +Condition that compares the metric value to a given constant value using a comparison operator. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Condition that compares the metric value to a given constant value using a comparison operator. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[comparison](#comparison)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# comparison + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**value** | decimal.Decimal, int, float, | decimal.Decimal, | | +**operator** | str, | str, | | must be one of ["GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ComparisonWrapper.md b/gooddata-api-client/docs/models/ComparisonWrapper.md new file mode 100644 index 000000000..976ccf48b --- /dev/null +++ b/gooddata-api-client/docs/models/ComparisonWrapper.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.comparison_wrapper.ComparisonWrapper + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**comparison** | [**Comparison**](Comparison.md) | [**Comparison**](Comparison.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/CompoundMeasureValueFilter.md b/gooddata-api-client/docs/models/CompoundMeasureValueFilter.md new file mode 100644 index 000000000..ad2856ca9 --- /dev/null +++ b/gooddata-api-client/docs/models/CompoundMeasureValueFilter.md @@ -0,0 +1,63 @@ +# gooddata_api_client.model.compound_measure_value_filter.CompoundMeasureValueFilter + +Filter the result by applying multiple comparison and/or range conditions combined with OR logic. If conditions list is empty, no filtering is applied (all rows are returned). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Filter the result by applying multiple comparison and/or range conditions combined with OR logic. If conditions list is empty, no filtering is applied (all rows are returned). | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[compoundMeasureValueFilter](#compoundMeasureValueFilter)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# compoundMeasureValueFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**measure** | [**AfmIdentifier**](AfmIdentifier.md) | [**AfmIdentifier**](AfmIdentifier.md) | | +**[conditions](#conditions)** | list, tuple, | tuple, | List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned. | +**applyOnResult** | bool, | BoolClass, | | [optional] +**[dimensionality](#dimensionality)** | list, tuple, | tuple, | References to the attributes to be used when filtering. | [optional] +**localIdentifier** | str, | str, | | [optional] +**treatNullValuesAs** | decimal.Decimal, int, float, | decimal.Decimal, | A value that will be substituted for null values in the metric for the comparisons. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# conditions + +List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**MeasureValueCondition**](MeasureValueCondition.md) | [**MeasureValueCondition**](MeasureValueCondition.md) | [**MeasureValueCondition**](MeasureValueCondition.md) | | + +# dimensionality + +References to the attributes to be used when filtering. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | References to the attributes to be used when filtering. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AfmIdentifier**](AfmIdentifier.md) | [**AfmIdentifier**](AfmIdentifier.md) | [**AfmIdentifier**](AfmIdentifier.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ContentSlideTemplate.md b/gooddata-api-client/docs/models/ContentSlideTemplate.md new file mode 100644 index 000000000..fd55ed6a9 --- /dev/null +++ b/gooddata-api-client/docs/models/ContentSlideTemplate.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.content_slide_template.ContentSlideTemplate + +Settings for content slide. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Settings for content slide. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**descriptionField** | None, str, | NoneClass, str, | | [optional] +**footer** | [**RunningSection**](RunningSection.md) | [**RunningSection**](RunningSection.md) | | [optional] +**header** | [**RunningSection**](RunningSection.md) | [**RunningSection**](RunningSection.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/CoverSlideTemplate.md b/gooddata-api-client/docs/models/CoverSlideTemplate.md new file mode 100644 index 000000000..84350b058 --- /dev/null +++ b/gooddata-api-client/docs/models/CoverSlideTemplate.md @@ -0,0 +1,20 @@ +# gooddata_api_client.model.cover_slide_template.CoverSlideTemplate + +Settings for cover slide. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Settings for cover slide. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**backgroundImage** | bool, | BoolClass, | Show background image on the slide. | [optional] if omitted the server will use the default value of True +**descriptionField** | None, str, | NoneClass, str, | | [optional] +**footer** | [**RunningSection**](RunningSection.md) | [**RunningSection**](RunningSection.md) | | [optional] +**header** | [**RunningSection**](RunningSection.md) | [**RunningSection**](RunningSection.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/CreateKnowledgeDocumentRequestDto.md b/gooddata-api-client/docs/models/CreateKnowledgeDocumentRequestDto.md new file mode 100644 index 000000000..0e05c5da1 --- /dev/null +++ b/gooddata-api-client/docs/models/CreateKnowledgeDocumentRequestDto.md @@ -0,0 +1,43 @@ +# gooddata_api_client.model.create_knowledge_document_request_dto.CreateKnowledgeDocumentRequestDto + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**filename** | str, | str, | | +**content** | str, | str, | | +**[pageBoundaries](#pageBoundaries)** | list, tuple, | tuple, | | [optional] +**[scopes](#scopes)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# pageBoundaries + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +# scopes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/CreateKnowledgeDocumentResponseDto.md b/gooddata-api-client/docs/models/CreateKnowledgeDocumentResponseDto.md new file mode 100644 index 000000000..dbcf20e40 --- /dev/null +++ b/gooddata-api-client/docs/models/CreateKnowledgeDocumentResponseDto.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.create_knowledge_document_response_dto.CreateKnowledgeDocumentResponseDto + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**numChunks** | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer +**filename** | str, | str, | | +**success** | bool, | BoolClass, | | +**message** | str, | str, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/CreatedVisualization.md b/gooddata-api-client/docs/models/CreatedVisualization.md new file mode 100644 index 000000000..b00ad593d --- /dev/null +++ b/gooddata-api-client/docs/models/CreatedVisualization.md @@ -0,0 +1,98 @@ +# gooddata_api_client.model.created_visualization.CreatedVisualization + +List of created visualization objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | List of created visualization objects | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[dimensionality](#dimensionality)** | list, tuple, | tuple, | List of attributes representing the dimensionality of the new visualization | +**visualizationType** | str, | str, | Visualization type requested in question | must be one of ["TABLE", "HEADLINE", "BAR", "LINE", "PIE", "COLUMN", "SCATTER", ] +**[suggestions](#suggestions)** | list, tuple, | tuple, | Suggestions for next steps | +**[filters](#filters)** | list, tuple, | tuple, | List of filters to be applied to the new visualization | +**id** | str, | str, | Proposed ID of the new visualization | +**[metrics](#metrics)** | list, tuple, | tuple, | List of metrics to be used in the new visualization | +**title** | str, | str, | Proposed title of the new visualization | +**config** | [**VisualizationConfig**](VisualizationConfig.md) | [**VisualizationConfig**](VisualizationConfig.md) | | [optional] +**savedVisualizationId** | str, | str, | Saved visualization ID. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dimensionality + +List of attributes representing the dimensionality of the new visualization + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of attributes representing the dimensionality of the new visualization | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DimAttribute**](DimAttribute.md) | [**DimAttribute**](DimAttribute.md) | [**DimAttribute**](DimAttribute.md) | | + +# filters + +List of filters to be applied to the new visualization + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of filters to be applied to the new visualization | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AttributeNegativeFilter](AttributeNegativeFilter.md) | [**AttributeNegativeFilter**](AttributeNegativeFilter.md) | [**AttributeNegativeFilter**](AttributeNegativeFilter.md) | | +[AttributePositiveFilter](AttributePositiveFilter.md) | [**AttributePositiveFilter**](AttributePositiveFilter.md) | [**AttributePositiveFilter**](AttributePositiveFilter.md) | | +[DateAbsoluteFilter](DateAbsoluteFilter.md) | [**DateAbsoluteFilter**](DateAbsoluteFilter.md) | [**DateAbsoluteFilter**](DateAbsoluteFilter.md) | | +[DateRelativeFilter](DateRelativeFilter.md) | [**DateRelativeFilter**](DateRelativeFilter.md) | [**DateRelativeFilter**](DateRelativeFilter.md) | | +[RankingFilter](RankingFilter.md) | [**RankingFilter**](RankingFilter.md) | [**RankingFilter**](RankingFilter.md) | | + +# metrics + +List of metrics to be used in the new visualization + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of metrics to be used in the new visualization | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**Metric**](Metric.md) | [**Metric**](Metric.md) | [**Metric**](Metric.md) | | + +# suggestions + +Suggestions for next steps + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Suggestions for next steps | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**Suggestion**](Suggestion.md) | [**Suggestion**](Suggestion.md) | [**Suggestion**](Suggestion.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/CreatedVisualizations.md b/gooddata-api-client/docs/models/CreatedVisualizations.md new file mode 100644 index 000000000..df8911c9c --- /dev/null +++ b/gooddata-api-client/docs/models/CreatedVisualizations.md @@ -0,0 +1,47 @@ +# gooddata_api_client.model.created_visualizations.CreatedVisualizations + +Visualization definitions created by AI. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Visualization definitions created by AI. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[objects](#objects)** | list, tuple, | tuple, | List of created visualization objects | +**reasoning** | str, | str, | DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated. | +**[suggestions](#suggestions)** | list, tuple, | tuple, | List of suggestions for next steps. Filled when no visualization was created, suggests alternatives. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# objects + +List of created visualization objects + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of created visualization objects | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**CreatedVisualization**](CreatedVisualization.md) | [**CreatedVisualization**](CreatedVisualization.md) | [**CreatedVisualization**](CreatedVisualization.md) | | + +# suggestions + +List of suggestions for next steps. Filled when no visualization was created, suggests alternatives. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of suggestions for next steps. Filled when no visualization was created, suggests alternatives. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**Suggestion**](Suggestion.md) | [**Suggestion**](Suggestion.md) | [**Suggestion**](Suggestion.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DashboardAttributeFilter.md b/gooddata-api-client/docs/models/DashboardAttributeFilter.md new file mode 100644 index 000000000..5c61a8d58 --- /dev/null +++ b/gooddata-api-client/docs/models/DashboardAttributeFilter.md @@ -0,0 +1,72 @@ +# gooddata_api_client.model.dashboard_attribute_filter.DashboardAttributeFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributeFilter](#attributeFilter)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributeFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**negativeSelection** | bool, | BoolClass, | | +**displayForm** | [**IdentifierRef**](IdentifierRef.md) | [**IdentifierRef**](IdentifierRef.md) | | +**attributeElements** | [**AttributeElements**](AttributeElements.md) | [**AttributeElements**](AttributeElements.md) | | +**[filterElementsBy](#filterElementsBy)** | list, tuple, | tuple, | | [optional] +**[filterElementsByDate](#filterElementsByDate)** | list, tuple, | tuple, | | [optional] +**localIdentifier** | str, | str, | | [optional] +**selectionMode** | str, | str, | | [optional] must be one of ["single", "multi", ] +**title** | str, | str, | | [optional] +**[validateElementsBy](#validateElementsBy)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# filterElementsBy + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AttributeFilterParent**](AttributeFilterParent.md) | [**AttributeFilterParent**](AttributeFilterParent.md) | [**AttributeFilterParent**](AttributeFilterParent.md) | | + +# filterElementsByDate + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AttributeFilterByDate**](AttributeFilterByDate.md) | [**AttributeFilterByDate**](AttributeFilterByDate.md) | [**AttributeFilterByDate**](AttributeFilterByDate.md) | | + +# validateElementsBy + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**IdentifierRef**](IdentifierRef.md) | [**IdentifierRef**](IdentifierRef.md) | [**IdentifierRef**](IdentifierRef.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DashboardDateFilter.md b/gooddata-api-client/docs/models/DashboardDateFilter.md new file mode 100644 index 000000000..752ba6379 --- /dev/null +++ b/gooddata-api-client/docs/models/DashboardDateFilter.md @@ -0,0 +1,92 @@ +# gooddata_api_client.model.dashboard_date_filter.DashboardDateFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[dateFilter](#dateFilter)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dateFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**granularity** | str, | str, | | must be one of ["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.fiscal_month", "GDC.time.fiscal_quarter", "GDC.time.fiscal_year", ] +**type** | str, | str, | | must be one of ["relative", "absolute", ] +**attribute** | [**IdentifierRef**](IdentifierRef.md) | [**IdentifierRef**](IdentifierRef.md) | | [optional] +**boundedFilter** | [**RelativeBoundedDateFilter**](RelativeBoundedDateFilter.md) | [**RelativeBoundedDateFilter**](RelativeBoundedDateFilter.md) | | [optional] +**dataSet** | [**IdentifierRef**](IdentifierRef.md) | [**IdentifierRef**](IdentifierRef.md) | | [optional] +**emptyValueHandling** | str, | str, | | [optional] must be one of ["INCLUDE", "EXCLUDE", "ONLY", ] +**[from](#from)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] +**localIdentifier** | str, | str, | | [optional] +**[to](#to)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# from + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +# to + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[one_of_0](#one_of_0) | str, | str, | | +[one_of_1](#one_of_1) | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +# one_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, | str, | | + +# one_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DashboardExportSettings.md b/gooddata-api-client/docs/models/DashboardExportSettings.md new file mode 100644 index 000000000..fea0363c8 --- /dev/null +++ b/gooddata-api-client/docs/models/DashboardExportSettings.md @@ -0,0 +1,20 @@ +# gooddata_api_client.model.dashboard_export_settings.DashboardExportSettings + +Additional settings. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Additional settings. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**exportInfo** | bool, | BoolClass, | If true, the export will contain the information about the export – exported date, dashboard filters, etc. | [optional] if omitted the server will use the default value of False +**mergeHeaders** | bool, | BoolClass, | Merge equal headers in neighbouring cells. Used for [XLSX] format only. | [optional] if omitted the server will use the default value of False +**pageOrientation** | str, | str, | Set page orientation. (PDF) | [optional] must be one of ["PORTRAIT", "LANDSCAPE", ] if omitted the server will use the default value of "PORTRAIT" +**pageSize** | str, | str, | Set page size. (PDF) | [optional] must be one of ["A3", "A4", "LETTER", ] if omitted the server will use the default value of "A4" +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DashboardFilter.md b/gooddata-api-client/docs/models/DashboardFilter.md new file mode 100644 index 000000000..890feb0e4 --- /dev/null +++ b/gooddata-api-client/docs/models/DashboardFilter.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.dashboard_filter.DashboardFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[DashboardAttributeFilter](DashboardAttributeFilter.md) | [**DashboardAttributeFilter**](DashboardAttributeFilter.md) | [**DashboardAttributeFilter**](DashboardAttributeFilter.md) | | +[DashboardDateFilter](DashboardDateFilter.md) | [**DashboardDateFilter**](DashboardDateFilter.md) | [**DashboardDateFilter**](DashboardDateFilter.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DashboardPermissionsAssignment.md b/gooddata-api-client/docs/models/DashboardPermissionsAssignment.md new file mode 100644 index 000000000..0b04eed92 --- /dev/null +++ b/gooddata-api-client/docs/models/DashboardPermissionsAssignment.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.dashboard_permissions_assignment.DashboardPermissionsAssignment + +Desired levels of permissions for an assignee. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Desired levels of permissions for an assignee. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[permissions](#permissions)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# permissions + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["EDIT", "SHARE", "VIEW", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DashboardSlidesTemplate.md b/gooddata-api-client/docs/models/DashboardSlidesTemplate.md new file mode 100644 index 000000000..95e70682f --- /dev/null +++ b/gooddata-api-client/docs/models/DashboardSlidesTemplate.md @@ -0,0 +1,35 @@ +# gooddata_api_client.model.dashboard_slides_template.DashboardSlidesTemplate + +Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[appliedOn](#appliedOn)** | list, tuple, | tuple, | Export types this template applies to. | +**contentSlide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] +**coverSlide** | [**CoverSlideTemplate**](CoverSlideTemplate.md) | [**CoverSlideTemplate**](CoverSlideTemplate.md) | | [optional] +**introSlide** | [**IntroSlideTemplate**](IntroSlideTemplate.md) | [**IntroSlideTemplate**](IntroSlideTemplate.md) | | [optional] +**sectionSlide** | [**SectionSlideTemplate**](SectionSlideTemplate.md) | [**SectionSlideTemplate**](SectionSlideTemplate.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# appliedOn + +Export types this template applies to. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Export types this template applies to. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["PDF", "PPTX", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DashboardTabularExportRequest.md b/gooddata-api-client/docs/models/DashboardTabularExportRequest.md new file mode 100644 index 000000000..09b479894 --- /dev/null +++ b/gooddata-api-client/docs/models/DashboardTabularExportRequest.md @@ -0,0 +1,76 @@ +# gooddata_api_client.model.dashboard_tabular_export_request.DashboardTabularExportRequest + +Export request object describing the export properties for dashboard tabular exports. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Export request object describing the export properties for dashboard tabular exports. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**fileName** | str, | str, | Filename of downloaded file without extension. | +**format** | str, | str, | Requested tabular export type. | must be one of ["XLSX", "PDF", ] +**[dashboardFiltersOverride](#dashboardFiltersOverride)** | list, tuple, | tuple, | List of filters that will be used instead of the default dashboard filters. | [optional] +**[dashboardTabsFiltersOverrides](#dashboardTabsFiltersOverrides)** | dict, frozendict.frozendict, | frozendict.frozendict, | Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab. | [optional] +**settings** | [**DashboardExportSettings**](DashboardExportSettings.md) | [**DashboardExportSettings**](DashboardExportSettings.md) | | [optional] +**[widgetIds](#widgetIds)** | list, tuple, | tuple, | List of widget identifiers to be exported. Note that only one widget is currently supported. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dashboardFiltersOverride + +List of filters that will be used instead of the default dashboard filters. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of filters that will be used instead of the default dashboard filters. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DashboardFilter**](DashboardFilter.md) | [**DashboardFilter**](DashboardFilter.md) | [**DashboardFilter**](DashboardFilter.md) | | + +# dashboardTabsFiltersOverrides + +Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[any_string_name](#any_string_name)** | list, tuple, | tuple, | any string name can be used but the value must be the correct type | [optional] + +# any_string_name + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DashboardFilter**](DashboardFilter.md) | [**DashboardFilter**](DashboardFilter.md) | [**DashboardFilter**](DashboardFilter.md) | | + +# widgetIds + +List of widget identifiers to be exported. Note that only one widget is currently supported. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of widget identifiers to be exported. Note that only one widget is currently supported. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DashboardTabularExportRequestV2.md b/gooddata-api-client/docs/models/DashboardTabularExportRequestV2.md new file mode 100644 index 000000000..2a59387fd --- /dev/null +++ b/gooddata-api-client/docs/models/DashboardTabularExportRequestV2.md @@ -0,0 +1,77 @@ +# gooddata_api_client.model.dashboard_tabular_export_request_v2.DashboardTabularExportRequestV2 + +Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId). | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**fileName** | str, | str, | Filename of downloaded file without extension. | +**dashboardId** | str, | str, | Dashboard identifier | +**format** | str, | str, | Requested tabular export type. | must be one of ["XLSX", "PDF", ] +**[dashboardFiltersOverride](#dashboardFiltersOverride)** | list, tuple, | tuple, | List of filters that will be used instead of the default dashboard filters. | [optional] +**[dashboardTabsFiltersOverrides](#dashboardTabsFiltersOverrides)** | dict, frozendict.frozendict, | frozendict.frozendict, | Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab. | [optional] +**settings** | [**DashboardExportSettings**](DashboardExportSettings.md) | [**DashboardExportSettings**](DashboardExportSettings.md) | | [optional] +**[widgetIds](#widgetIds)** | list, tuple, | tuple, | List of widget identifiers to be exported. Note that only one widget is currently supported. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dashboardFiltersOverride + +List of filters that will be used instead of the default dashboard filters. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of filters that will be used instead of the default dashboard filters. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DashboardFilter**](DashboardFilter.md) | [**DashboardFilter**](DashboardFilter.md) | [**DashboardFilter**](DashboardFilter.md) | | + +# dashboardTabsFiltersOverrides + +Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[any_string_name](#any_string_name)** | list, tuple, | tuple, | any string name can be used but the value must be the correct type | [optional] + +# any_string_name + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DashboardFilter**](DashboardFilter.md) | [**DashboardFilter**](DashboardFilter.md) | [**DashboardFilter**](DashboardFilter.md) | | + +# widgetIds + +List of widget identifiers to be exported. Note that only one widget is currently supported. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of widget identifiers to be exported. Note that only one widget is currently supported. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DataSourcePermissionAssignment.md b/gooddata-api-client/docs/models/DataSourcePermissionAssignment.md new file mode 100644 index 000000000..b9e13ffe5 --- /dev/null +++ b/gooddata-api-client/docs/models/DataSourcePermissionAssignment.md @@ -0,0 +1,30 @@ +# gooddata_api_client.model.data_source_permission_assignment.DataSourcePermissionAssignment + +Data source permission assignments + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Data source permission assignments | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**assigneeIdentifier** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | +**[permissions](#permissions)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# permissions + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["MANAGE", "USE", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DatabaseInstance.md b/gooddata-api-client/docs/models/DatabaseInstance.md new file mode 100644 index 000000000..ad09dfb4a --- /dev/null +++ b/gooddata-api-client/docs/models/DatabaseInstance.md @@ -0,0 +1,33 @@ +# gooddata_api_client.model.database_instance.DatabaseInstance + +A single AI Lake Database instance + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A single AI Lake Database instance | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[storageIds](#storageIds)** | list, tuple, | tuple, | Set of ids of the storage instances this database instance should access. | +**name** | str, | str, | Name of the AI Lake Database instance | +**id** | str, | str, | Id of the AI Lake Database instance | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# storageIds + +Set of ids of the storage instances this database instance should access. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Set of ids of the storage instances this database instance should access. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Set of ids of the storage instances this database instance should access. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DatasetGrain.md b/gooddata-api-client/docs/models/DatasetGrain.md new file mode 100644 index 000000000..4876cf153 --- /dev/null +++ b/gooddata-api-client/docs/models/DatasetGrain.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.dataset_grain.DatasetGrain + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**type** | str, | str, | | must be one of ["attribute", "date", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DatasetWorkspaceDataFilterIdentifier.md b/gooddata-api-client/docs/models/DatasetWorkspaceDataFilterIdentifier.md new file mode 100644 index 000000000..a660d1253 --- /dev/null +++ b/gooddata-api-client/docs/models/DatasetWorkspaceDataFilterIdentifier.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.dataset_workspace_data_filter_identifier.DatasetWorkspaceDataFilterIdentifier + +Identifier of a workspace data filter. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Identifier of a workspace data filter. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Workspace Data Filters ID. | +**type** | str, | str, | Filter type. | must be one of ["workspaceDataFilter", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DateAbsoluteFilter.md b/gooddata-api-client/docs/models/DateAbsoluteFilter.md new file mode 100644 index 000000000..e5efea2a0 --- /dev/null +++ b/gooddata-api-client/docs/models/DateAbsoluteFilter.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.date_absolute_filter.DateAbsoluteFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[Filter](Filter.md) | [**Filter**](Filter.md) | [**Filter**](Filter.md) | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**from** | str, | str, | | [optional] +**to** | str, | str, | | [optional] +**using** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DateRelativeFilter.md b/gooddata-api-client/docs/models/DateRelativeFilter.md new file mode 100644 index 000000000..6b41ff5b1 --- /dev/null +++ b/gooddata-api-client/docs/models/DateRelativeFilter.md @@ -0,0 +1,32 @@ +# gooddata_api_client.model.date_relative_filter.DateRelativeFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[Filter](Filter.md) | [**Filter**](Filter.md) | [**Filter**](Filter.md) | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**from** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer +**granularity** | str, | str, | | [optional] must be one of ["MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR", ] +**to** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer +**using** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DateValue.md b/gooddata-api-client/docs/models/DateValue.md new file mode 100644 index 000000000..7420929e7 --- /dev/null +++ b/gooddata-api-client/docs/models/DateValue.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.date_value.DateValue + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**value** | str, | str, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeAggregatedFact.md b/gooddata-api-client/docs/models/DeclarativeAggregatedFact.md new file mode 100644 index 000000000..f5a8a9da9 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeAggregatedFact.md @@ -0,0 +1,38 @@ +# gooddata_api_client.model.declarative_aggregated_fact.DeclarativeAggregatedFact + +A dataset fact. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A dataset fact. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**sourceFactReference** | [**DeclarativeSourceFactReference**](DeclarativeSourceFactReference.md) | [**DeclarativeSourceFactReference**](DeclarativeSourceFactReference.md) | | +**id** | str, | str, | Fact ID. | +**sourceColumn** | str, | str, | A name of the source column in the table. | +**description** | str, | str, | Fact description. | [optional] +**isNullable** | bool, | BoolClass, | Flag indicating whether the associated source column allows null values. | [optional] +**nullValue** | str, | str, | Value used in coalesce during joins instead of null. | [optional] +**sourceColumnDataType** | str, | str, | A type of the source column | [optional] must be one of ["INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", ] +**[tags](#tags)** | list, tuple, | tuple, | A list of tags. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +A list of tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | A list of tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | A list of tags. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardIdentifier.md b/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardIdentifier.md new file mode 100644 index 000000000..ada9f19df --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardIdentifier.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.declarative_analytical_dashboard_identifier.DeclarativeAnalyticalDashboardIdentifier + +An analytical dashboard identifier. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | An analytical dashboard identifier. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Identifier of the analytical dashboard. | +**type** | str, | str, | A type. | must be one of ["analyticalDashboard", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardPermissionAssignment.md b/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardPermissionAssignment.md new file mode 100644 index 000000000..927fa40b4 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardPermissionAssignment.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.declarative_analytical_dashboard_permission_assignment.DeclarativeAnalyticalDashboardPermissionAssignment + +Analytical dashboard permission. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Analytical dashboard permission. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**name** | str, | str, | Permission name. | must be one of ["EDIT", "SHARE", "VIEW", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardPermissionForAssignee.md b/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardPermissionForAssignee.md new file mode 100644 index 000000000..8a9f42115 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardPermissionForAssignee.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.declarative_analytical_dashboard_permission_for_assignee.DeclarativeAnalyticalDashboardPermissionForAssignee + +Analytical dashboard permission for an assignee. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Analytical dashboard permission for an assignee. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[DeclarativeAnalyticalDashboardPermissionAssignment](DeclarativeAnalyticalDashboardPermissionAssignment.md) | [**DeclarativeAnalyticalDashboardPermissionAssignment**](DeclarativeAnalyticalDashboardPermissionAssignment.md) | [**DeclarativeAnalyticalDashboardPermissionAssignment**](DeclarativeAnalyticalDashboardPermissionAssignment.md) | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**assignee** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardPermissionForAssigneeRule.md b/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardPermissionForAssigneeRule.md new file mode 100644 index 000000000..c7761a8ee --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeAnalyticalDashboardPermissionForAssigneeRule.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.declarative_analytical_dashboard_permission_for_assignee_rule.DeclarativeAnalyticalDashboardPermissionForAssigneeRule + +Analytical dashboard permission for a collection of assignees identified by a rule. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Analytical dashboard permission for a collection of assignees identified by a rule. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[DeclarativeAnalyticalDashboardPermissionAssignment](DeclarativeAnalyticalDashboardPermissionAssignment.md) | [**DeclarativeAnalyticalDashboardPermissionAssignment**](DeclarativeAnalyticalDashboardPermissionAssignment.md) | [**DeclarativeAnalyticalDashboardPermissionAssignment**](DeclarativeAnalyticalDashboardPermissionAssignment.md) | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**assigneeRule** | [**AssigneeRule**](AssigneeRule.md) | [**AssigneeRule**](AssigneeRule.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeAttributeHierarchy.md b/gooddata-api-client/docs/models/DeclarativeAttributeHierarchy.md new file mode 100644 index 000000000..f77ae4d3c --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeAttributeHierarchy.md @@ -0,0 +1,37 @@ +# gooddata_api_client.model.declarative_attribute_hierarchy.DeclarativeAttributeHierarchy + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Attribute hierarchy object ID. | +**title** | str, | str, | Attribute hierarchy object title. | +**content** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | +**createdAt** | None, str, | NoneClass, str, | Time of the entity creation. | [optional] +**createdBy** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] +**description** | str, | str, | Attribute hierarchy object description. | [optional] +**modifiedAt** | None, str, | NoneClass, str, | Time of the last entity modification. | [optional] +**modifiedBy** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] +**[tags](#tags)** | list, tuple, | tuple, | A list of tags. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +A list of tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | A list of tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | A list of tags. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeAutomation.md b/gooddata-api-client/docs/models/DeclarativeAutomation.md new file mode 100644 index 000000000..2703bc19b --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeAutomation.md @@ -0,0 +1,175 @@ +# gooddata_api_client.model.declarative_automation.DeclarativeAutomation + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**alert** | [**AutomationAlert**](AutomationAlert.md) | [**AutomationAlert**](AutomationAlert.md) | | [optional] +**analyticalDashboard** | [**DeclarativeAnalyticalDashboardIdentifier**](DeclarativeAnalyticalDashboardIdentifier.md) | [**DeclarativeAnalyticalDashboardIdentifier**](DeclarativeAnalyticalDashboardIdentifier.md) | | [optional] +**createdAt** | None, str, | NoneClass, str, | Time of the entity creation. | [optional] +**createdBy** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] +**[dashboardTabularExports](#dashboardTabularExports)** | list, tuple, | tuple, | | [optional] +**description** | str, | str, | | [optional] +**[details](#details)** | dict, frozendict.frozendict, | frozendict.frozendict, | TODO | [optional] +**evaluationMode** | str, | str, | Specify automation evaluation mode. | [optional] must be one of ["SHARED", "PER_RECIPIENT", ] if omitted the server will use the default value of "PER_RECIPIENT" +**[exportDefinitions](#exportDefinitions)** | list, tuple, | tuple, | | [optional] +**[externalRecipients](#externalRecipients)** | list, tuple, | tuple, | External recipients of the automation action results. | [optional] +**[imageExports](#imageExports)** | list, tuple, | tuple, | | [optional] +**metadata** | [**AutomationMetadata**](AutomationMetadata.md) | [**AutomationMetadata**](AutomationMetadata.md) | | [optional] +**modifiedAt** | None, str, | NoneClass, str, | Time of the last entity modification. | [optional] +**modifiedBy** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] +**notificationChannel** | [**DeclarativeNotificationChannelIdentifier**](DeclarativeNotificationChannelIdentifier.md) | [**DeclarativeNotificationChannelIdentifier**](DeclarativeNotificationChannelIdentifier.md) | | [optional] +**[rawExports](#rawExports)** | list, tuple, | tuple, | | [optional] +**[recipients](#recipients)** | list, tuple, | tuple, | | [optional] +**schedule** | [**AutomationSchedule**](AutomationSchedule.md) | [**AutomationSchedule**](AutomationSchedule.md) | | [optional] +**[slidesExports](#slidesExports)** | list, tuple, | tuple, | | [optional] +**state** | str, | str, | Current state of the automation. | [optional] must be one of ["ACTIVE", "PAUSED", ] if omitted the server will use the default value of "ACTIVE" +**[tabularExports](#tabularExports)** | list, tuple, | tuple, | | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**[visualExports](#visualExports)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dashboardTabularExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AutomationDashboardTabularExport**](AutomationDashboardTabularExport.md) | [**AutomationDashboardTabularExport**](AutomationDashboardTabularExport.md) | [**AutomationDashboardTabularExport**](AutomationDashboardTabularExport.md) | | + +# details + +TODO + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | TODO | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str, | str, | any string name can be used but the value must be the correct type TODO | [optional] + +# exportDefinitions + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DeclarativeExportDefinitionIdentifier**](DeclarativeExportDefinitionIdentifier.md) | [**DeclarativeExportDefinitionIdentifier**](DeclarativeExportDefinitionIdentifier.md) | [**DeclarativeExportDefinitionIdentifier**](DeclarativeExportDefinitionIdentifier.md) | | + +# externalRecipients + +External recipients of the automation action results. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | External recipients of the automation action results. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AutomationExternalRecipient**](AutomationExternalRecipient.md) | [**AutomationExternalRecipient**](AutomationExternalRecipient.md) | [**AutomationExternalRecipient**](AutomationExternalRecipient.md) | | + +# imageExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AutomationImageExport**](AutomationImageExport.md) | [**AutomationImageExport**](AutomationImageExport.md) | [**AutomationImageExport**](AutomationImageExport.md) | | + +# rawExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AutomationRawExport**](AutomationRawExport.md) | [**AutomationRawExport**](AutomationRawExport.md) | [**AutomationRawExport**](AutomationRawExport.md) | | + +# recipients + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | + +# slidesExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AutomationSlidesExport**](AutomationSlidesExport.md) | [**AutomationSlidesExport**](AutomationSlidesExport.md) | [**AutomationSlidesExport**](AutomationSlidesExport.md) | | + +# tabularExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AutomationTabularExport**](AutomationTabularExport.md) | [**AutomationTabularExport**](AutomationTabularExport.md) | [**AutomationTabularExport**](AutomationTabularExport.md) | | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | A list of tags. | + +# visualExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AutomationVisualExport**](AutomationVisualExport.md) | [**AutomationVisualExport**](AutomationVisualExport.md) | [**AutomationVisualExport**](AutomationVisualExport.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeCustomGeoCollection.md b/gooddata-api-client/docs/models/DeclarativeCustomGeoCollection.md new file mode 100644 index 000000000..02ed75b16 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeCustomGeoCollection.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.declarative_custom_geo_collection.DeclarativeCustomGeoCollection + +A declarative form of custom geo collection. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A declarative form of custom geo collection. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Custom geo collection ID. | +**description** | str, | str, | Description of the custom geo collection. | [optional] +**name** | str, | str, | Name of the custom geo collection. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeCustomGeoCollections.md b/gooddata-api-client/docs/models/DeclarativeCustomGeoCollections.md new file mode 100644 index 000000000..48d815efd --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeCustomGeoCollections.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.declarative_custom_geo_collections.DeclarativeCustomGeoCollections + +Custom geo collections. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Custom geo collections. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[customGeoCollections](#customGeoCollections)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# customGeoCollections + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DeclarativeCustomGeoCollection**](DeclarativeCustomGeoCollection.md) | [**DeclarativeCustomGeoCollection**](DeclarativeCustomGeoCollection.md) | [**DeclarativeCustomGeoCollection**](DeclarativeCustomGeoCollection.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeDataSourcePermissions.md b/gooddata-api-client/docs/models/DeclarativeDataSourcePermissions.md new file mode 100644 index 000000000..a2bee28bb --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeDataSourcePermissions.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.declarative_data_source_permissions.DeclarativeDataSourcePermissions + +Data source permissions. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Data source permissions. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[permissions](#permissions)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# permissions + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DeclarativeDataSourcePermission**](DeclarativeDataSourcePermission.md) | [**DeclarativeDataSourcePermission**](DeclarativeDataSourcePermission.md) | [**DeclarativeDataSourcePermission**](DeclarativeDataSourcePermission.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeDatasetExtension.md b/gooddata-api-client/docs/models/DeclarativeDatasetExtension.md new file mode 100644 index 000000000..4a70342bc --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeDatasetExtension.md @@ -0,0 +1,32 @@ +# gooddata_api_client.model.declarative_dataset_extension.DeclarativeDatasetExtension + +A dataset extension properties. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A dataset extension properties. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | The Dataset ID. This ID is further used to refer to this instance of dataset. | +**[workspaceDataFilterReferences](#workspaceDataFilterReferences)** | list, tuple, | tuple, | An array of explicit workspace data filters. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# workspaceDataFilterReferences + +An array of explicit workspace data filters. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | An array of explicit workspace data filters. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DeclarativeWorkspaceDataFilterReferences**](DeclarativeWorkspaceDataFilterReferences.md) | [**DeclarativeWorkspaceDataFilterReferences**](DeclarativeWorkspaceDataFilterReferences.md) | [**DeclarativeWorkspaceDataFilterReferences**](DeclarativeWorkspaceDataFilterReferences.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeExportDefinition.md b/gooddata-api-client/docs/models/DeclarativeExportDefinition.md new file mode 100644 index 000000000..0c80020cc --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeExportDefinition.md @@ -0,0 +1,51 @@ +# gooddata_api_client.model.declarative_export_definition.DeclarativeExportDefinition + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Export definition id. | +**title** | str, | str, | Export definition object title. | +**createdAt** | None, str, | NoneClass, str, | Time of the entity creation. | [optional] +**createdBy** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] +**description** | str, | str, | Export definition object description. | [optional] +**modifiedAt** | None, str, | NoneClass, str, | Time of the last entity modification. | [optional] +**modifiedBy** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] +**[requestPayload](#requestPayload)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] +**[tags](#tags)** | list, tuple, | tuple, | A list of tags. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# requestPayload + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[TabularExportRequest](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | | +[VisualExportRequest](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | | + +# tags + +A list of tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | A list of tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | A list of tags. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeExportDefinitionIdentifier.md b/gooddata-api-client/docs/models/DeclarativeExportDefinitionIdentifier.md new file mode 100644 index 000000000..db4d035d0 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeExportDefinitionIdentifier.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.declarative_export_definition_identifier.DeclarativeExportDefinitionIdentifier + +An export definition identifier. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | An export definition identifier. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Export definition identifier. | +**type** | str, | str, | A type. | must be one of ["exportDefinition", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeExportTemplate.md b/gooddata-api-client/docs/models/DeclarativeExportTemplate.md new file mode 100644 index 000000000..a43db8288 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeExportTemplate.md @@ -0,0 +1,20 @@ +# gooddata_api_client.model.declarative_export_template.DeclarativeExportTemplate + +A declarative form of a particular export template. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A declarative form of a particular export template. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**name** | str, | str, | Name of an export template. | +**id** | str, | str, | Identifier of an export template | +**dashboardSlidesTemplate** | [**DashboardSlidesTemplate**](DashboardSlidesTemplate.md) | [**DashboardSlidesTemplate**](DashboardSlidesTemplate.md) | | [optional] +**widgetSlidesTemplate** | [**WidgetSlidesTemplate**](WidgetSlidesTemplate.md) | [**WidgetSlidesTemplate**](WidgetSlidesTemplate.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeExportTemplates.md b/gooddata-api-client/docs/models/DeclarativeExportTemplates.md new file mode 100644 index 000000000..7d31fd6a7 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeExportTemplates.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.declarative_export_templates.DeclarativeExportTemplates + +Export templates. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Export templates. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[exportTemplates](#exportTemplates)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# exportTemplates + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DeclarativeExportTemplate**](DeclarativeExportTemplate.md) | [**DeclarativeExportTemplate**](DeclarativeExportTemplate.md) | [**DeclarativeExportTemplate**](DeclarativeExportTemplate.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeFilterView.md b/gooddata-api-client/docs/models/DeclarativeFilterView.md new file mode 100644 index 000000000..1a8ea76fa --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeFilterView.md @@ -0,0 +1,34 @@ +# gooddata_api_client.model.declarative_filter_view.DeclarativeFilterView + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | FilterView object ID. | +**title** | str, | str, | | +**analyticalDashboard** | [**DeclarativeAnalyticalDashboardIdentifier**](DeclarativeAnalyticalDashboardIdentifier.md) | [**DeclarativeAnalyticalDashboardIdentifier**](DeclarativeAnalyticalDashboardIdentifier.md) | | [optional] +**content** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**description** | str, | str, | | [optional] +**isDefault** | bool, | BoolClass, | Indicator whether the filter view should by applied by default. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**user** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | A list of tags. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeIdentityProvider.md b/gooddata-api-client/docs/models/DeclarativeIdentityProvider.md new file mode 100644 index 000000000..00cf8df02 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeIdentityProvider.md @@ -0,0 +1,84 @@ +# gooddata_api_client.model.declarative_identity_provider.DeclarativeIdentityProvider + +Notification channels. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Notification channels. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | FilterView object ID. | +**[customClaimMapping](#customClaimMapping)** | dict, frozendict.frozendict, | frozendict.frozendict, | Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. | [optional] +**[identifiers](#identifiers)** | list, tuple, | tuple, | List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. | [optional] +**idpType** | str, | str, | Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise. | [optional] must be one of ["MANAGED_IDP", "FIM_IDP", "DEX_IDP", "CUSTOM_IDP", ] +**oauthClientId** | str, | str, | The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] +**oauthClientSecret** | str, | str, | The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] +**[oauthCustomAuthAttributes](#oauthCustomAuthAttributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] +**[oauthCustomScopes](#oauthCustomScopes)** | list, tuple, None, | tuple, NoneClass, | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] +**oauthIssuerId** | str, | str, | Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider. | [optional] +**oauthIssuerLocation** | str, | str, | The location of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] +**oauthSubjectIdClaim** | str, | str, | Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'. | [optional] +**samlMetadata** | str, | str, | Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# customClaimMapping + +Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional] + +# identifiers + +List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. | + +# oauthCustomAuthAttributes + +Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str, | str, | any string name can be used but the value must be the correct type Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] + +# oauthCustomScopes + +List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, None, | tuple, NoneClass, | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeIdentityProviderIdentifier.md b/gooddata-api-client/docs/models/DeclarativeIdentityProviderIdentifier.md new file mode 100644 index 000000000..334229515 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeIdentityProviderIdentifier.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.declarative_identity_provider_identifier.DeclarativeIdentityProviderIdentifier + +An Identity Provider identifier. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | An Identity Provider identifier. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Identifier of the identity provider. | +**type** | str, | str, | A type. | must be one of ["identityProvider", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeJwk.md b/gooddata-api-client/docs/models/DeclarativeJwk.md new file mode 100644 index 000000000..1b5361c49 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeJwk.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.declarative_jwk.DeclarativeJwk + +A declarative form of the JWK. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A declarative form of the JWK. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | JWK object ID. | +**content** | [**DeclarativeJwkSpecification**](DeclarativeJwkSpecification.md) | [**DeclarativeJwkSpecification**](DeclarativeJwkSpecification.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeJwkSpecification.md b/gooddata-api-client/docs/models/DeclarativeJwkSpecification.md new file mode 100644 index 000000000..26607f437 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeJwkSpecification.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.declarative_jwk_specification.DeclarativeJwkSpecification + +Declarative specification of the cryptographic key. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Declarative specification of the cryptographic key. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[DeclarativeRsaSpecification](DeclarativeRsaSpecification.md) | [**DeclarativeRsaSpecification**](DeclarativeRsaSpecification.md) | [**DeclarativeRsaSpecification**](DeclarativeRsaSpecification.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeLabelTranslation.md b/gooddata-api-client/docs/models/DeclarativeLabelTranslation.md new file mode 100644 index 000000000..3319f7fc9 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeLabelTranslation.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.declarative_label_translation.DeclarativeLabelTranslation + +A label translation. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A label translation. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**locale** | str, | str, | Translation locale. | +**sourceColumn** | str, | str, | Translation source column. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeMemoryItem.md b/gooddata-api-client/docs/models/DeclarativeMemoryItem.md new file mode 100644 index 000000000..baa7b1f61 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeMemoryItem.md @@ -0,0 +1,54 @@ +# gooddata_api_client.model.declarative_memory_item.DeclarativeMemoryItem + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**instruction** | str, | str, | The text that will be injected into the system prompt. | +**id** | str, | str, | Memory item ID. | +**strategy** | str, | str, | Strategy defining when the memory item should be applied | must be one of ["ALWAYS", "AUTO", ] +**title** | str, | str, | Memory item title. | +**createdAt** | None, str, | NoneClass, str, | Time of the entity creation. | [optional] +**createdBy** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] +**description** | str, | str, | Memory item description. | [optional] +**isDisabled** | bool, | BoolClass, | Whether memory item is disabled. | [optional] +**[keywords](#keywords)** | list, tuple, | tuple, | Set of unique strings used for semantic similarity filtering. | [optional] +**modifiedAt** | None, str, | NoneClass, str, | Time of the last entity modification. | [optional] +**modifiedBy** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] +**[tags](#tags)** | list, tuple, | tuple, | A list of tags. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# keywords + +Set of unique strings used for semantic similarity filtering. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Set of unique strings used for semantic similarity filtering. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# tags + +A list of tags. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | A list of tags. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | A list of tags. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeNotificationChannel.md b/gooddata-api-client/docs/models/DeclarativeNotificationChannel.md new file mode 100644 index 000000000..2380c293d --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeNotificationChannel.md @@ -0,0 +1,42 @@ +# gooddata_api_client.model.declarative_notification_channel.DeclarativeNotificationChannel + +A declarative form of a particular notification channel. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A declarative form of a particular notification channel. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Identifier of a notification channel | +**allowedRecipients** | str, | str, | Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization | [optional] must be one of ["CREATOR", "INTERNAL", "EXTERNAL", ] if omitted the server will use the default value of "INTERNAL" +**customDashboardUrl** | str, | str, | Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} | [optional] +**dashboardLinkVisibility** | str, | str, | Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link | [optional] must be one of ["HIDDEN", "INTERNAL_ONLY", "ALL", ] if omitted the server will use the default value of "INTERNAL_ONLY" +**description** | str, | str, | Description of a notification channel. | [optional] +**[destination](#destination)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] +**destinationType** | None, str, | NoneClass, str, | | [optional] must be one of ["WEBHOOK", "SMTP", "DEFAULT_SMTP", "IN_PLATFORM", ] +**inPlatformNotification** | str, | str, | In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications | [optional] must be one of ["DISABLED", "ENABLED", ] if omitted the server will use the default value of "DISABLED" +**name** | str, | str, | Name of a notification channel. | [optional] +**notificationSource** | str, | str, | Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# destination + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[DefaultSmtp](DefaultSmtp.md) | [**DefaultSmtp**](DefaultSmtp.md) | [**DefaultSmtp**](DefaultSmtp.md) | | +[InPlatform](InPlatform.md) | [**InPlatform**](InPlatform.md) | [**InPlatform**](InPlatform.md) | | +[Smtp](Smtp.md) | [**Smtp**](Smtp.md) | [**Smtp**](Smtp.md) | | +[Webhook](Webhook.md) | [**Webhook**](Webhook.md) | [**Webhook**](Webhook.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeNotificationChannelIdentifier.md b/gooddata-api-client/docs/models/DeclarativeNotificationChannelIdentifier.md new file mode 100644 index 000000000..6c693206a --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeNotificationChannelIdentifier.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.declarative_notification_channel_identifier.DeclarativeNotificationChannelIdentifier + +A notification channel identifier. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A notification channel identifier. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Notification channel identifier. | +**type** | str, | str, | A type. | must be one of ["notificationChannel", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeNotificationChannels.md b/gooddata-api-client/docs/models/DeclarativeNotificationChannels.md new file mode 100644 index 000000000..27246d851 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeNotificationChannels.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.declarative_notification_channels.DeclarativeNotificationChannels + +Notification channels. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Notification channels. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[notificationChannels](#notificationChannels)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# notificationChannels + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**DeclarativeNotificationChannel**](DeclarativeNotificationChannel.md) | [**DeclarativeNotificationChannel**](DeclarativeNotificationChannel.md) | [**DeclarativeNotificationChannel**](DeclarativeNotificationChannel.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeReferenceSource.md b/gooddata-api-client/docs/models/DeclarativeReferenceSource.md new file mode 100644 index 000000000..9a7f9616a --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeReferenceSource.md @@ -0,0 +1,21 @@ +# gooddata_api_client.model.declarative_reference_source.DeclarativeReferenceSource + +A dataset reference source column description. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A dataset reference source column description. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**column** | str, | str, | A name of the source column in the table. | +**target** | [**GrainIdentifier**](GrainIdentifier.md) | [**GrainIdentifier**](GrainIdentifier.md) | | +**dataType** | str, | str, | A type of the source column. | [optional] must be one of ["INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", ] +**isNullable** | bool, | BoolClass, | Flag indicating whether the associated source column allows null values. | [optional] +**nullValue** | str, | str, | Value used in coalesce during joins instead of null. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeRsaSpecification.md b/gooddata-api-client/docs/models/DeclarativeRsaSpecification.md new file mode 100644 index 000000000..aaddd6d69 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeRsaSpecification.md @@ -0,0 +1,38 @@ +# gooddata_api_client.model.declarative_rsa_specification.DeclarativeRsaSpecification + +Declarative specification of the cryptographic key. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Declarative specification of the cryptographic key. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**kty** | str, | str, | Key type parameter | must be one of ["RSA", ] +**e** | str, | str, | parameter contains the exponent value for the RSA public key. | +**use** | str, | str, | Parameter identifies the intended use of the public key. | must be one of ["sig", ] +**kid** | str, | str, | Parameter is used to match a specific key. | +**alg** | str, | str, | Algorithm intended for use with the key. | must be one of ["RS256", "RS384", "RS512", ] +**n** | str, | str, | Parameter contains the modulus value for the RSA public key. | +**[x5c](#x5c)** | list, tuple, | tuple, | Parameter contains a chain of one or more PKIX certificates. | [optional] +**x5t** | str, | str, | Parameter is a base64url-encoded SHA-1 thumbprint of the DER encoding of an X.509 certificate. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# x5c + +Parameter contains a chain of one or more PKIX certificates. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Parameter contains a chain of one or more PKIX certificates. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeSourceFactReference.md b/gooddata-api-client/docs/models/DeclarativeSourceFactReference.md new file mode 100644 index 000000000..0b4947b32 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeSourceFactReference.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.declarative_source_fact_reference.DeclarativeSourceFactReference + +Aggregated awareness source fact reference. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Aggregated awareness source fact reference. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**reference** | [**FactIdentifier**](FactIdentifier.md) | [**FactIdentifier**](FactIdentifier.md) | | +**operation** | str, | str, | Aggregation operation. | must be one of ["SUM", "MIN", "MAX", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeUserIdentifier.md b/gooddata-api-client/docs/models/DeclarativeUserIdentifier.md new file mode 100644 index 000000000..6f0db2fc4 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeUserIdentifier.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.declarative_user_identifier.DeclarativeUserIdentifier + +A user identifier. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A user identifier. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | User identifier. | +**type** | str, | str, | A type. | must be one of ["user", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilterReferences.md b/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilterReferences.md new file mode 100644 index 000000000..ff078f7d4 --- /dev/null +++ b/gooddata-api-client/docs/models/DeclarativeWorkspaceDataFilterReferences.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.declarative_workspace_data_filter_references.DeclarativeWorkspaceDataFilterReferences + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**filterId** | [**DatasetWorkspaceDataFilterIdentifier**](DatasetWorkspaceDataFilterIdentifier.md) | [**DatasetWorkspaceDataFilterIdentifier**](DatasetWorkspaceDataFilterIdentifier.md) | | +**filterColumnDataType** | str, | str, | Filter column data type | must be one of ["INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", ] +**filterColumn** | str, | str, | Filter column name | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DefaultSmtp.md b/gooddata-api-client/docs/models/DefaultSmtp.md new file mode 100644 index 000000000..b705dfec4 --- /dev/null +++ b/gooddata-api-client/docs/models/DefaultSmtp.md @@ -0,0 +1,40 @@ +# gooddata_api_client.model.default_smtp.DefaultSmtp + +Default SMTP destination for notifications. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Default SMTP destination for notifications. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**type** | str, | str, | The destination type. | must be one of ["DEFAULT_SMTP", ] +**fromEmail** | str, | str, | E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead. | [optional] if omitted the server will use the default value of no-reply@gooddata.com +**fromEmailName** | str, | str, | An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead. | [optional] if omitted the server will use the default value of "GoodData" +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**fromEmail** | str, | str, | E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead. | [optional] if omitted the server will use the default value of no-reply@gooddata.com +**fromEmailName** | str, | str, | An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead. | [optional] if omitted the server will use the default value of "GoodData" +**type** | str, | str, | The destination type. | [optional] must be one of ["DEFAULT_SMTP", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DeleteKnowledgeDocumentResponseDto.md b/gooddata-api-client/docs/models/DeleteKnowledgeDocumentResponseDto.md new file mode 100644 index 000000000..80ba774ea --- /dev/null +++ b/gooddata-api-client/docs/models/DeleteKnowledgeDocumentResponseDto.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.delete_knowledge_document_response_dto.DeleteKnowledgeDocumentResponseDto + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**success** | bool, | BoolClass, | | +**message** | str, | str, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DependsOn.md b/gooddata-api-client/docs/models/DependsOn.md new file mode 100644 index 000000000..732ceddda --- /dev/null +++ b/gooddata-api-client/docs/models/DependsOn.md @@ -0,0 +1,47 @@ +# gooddata_api_client.model.depends_on.DependsOn + +Filter definition type specified by label and values. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Filter definition type specified by label and values. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[DependsOnItem](DependsOnItem.md) | [**DependsOnItem**](DependsOnItem.md) | [**DependsOnItem**](DependsOnItem.md) | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**complementFilter** | bool, | BoolClass, | Inverse filtering mode. | [optional] if omitted the server will use the default value of False +**label** | str, | str, | Specifies on which label the filter depends on. | [optional] +**[values](#values)** | list, tuple, | tuple, | Specifies values of the label for element filtering. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# values + +Specifies values of the label for element filtering. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Specifies values of the label for element filtering. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | None, str, | NoneClass, str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DependsOnDateFilter.md b/gooddata-api-client/docs/models/DependsOnDateFilter.md new file mode 100644 index 000000000..3d2e6283c --- /dev/null +++ b/gooddata-api-client/docs/models/DependsOnDateFilter.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.depends_on_date_filter.DependsOnDateFilter + +Filter definition type for dates. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Filter definition type for dates. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[DependsOnItem](DependsOnItem.md) | [**DependsOnItem**](DependsOnItem.md) | [**DependsOnItem**](DependsOnItem.md) | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**dateFilter** | [**DateFilter**](DateFilter.md) | [**DateFilter**](DateFilter.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DependsOnItem.md b/gooddata-api-client/docs/models/DependsOnItem.md new file mode 100644 index 000000000..97590bf49 --- /dev/null +++ b/gooddata-api-client/docs/models/DependsOnItem.md @@ -0,0 +1,9 @@ +# gooddata_api_client.model.depends_on_item.DependsOnItem + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/DimAttribute.md b/gooddata-api-client/docs/models/DimAttribute.md new file mode 100644 index 000000000..d3efe6c65 --- /dev/null +++ b/gooddata-api-client/docs/models/DimAttribute.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.dim_attribute.DimAttribute + +List of attributes representing the dimensionality of the new visualization + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | List of attributes representing the dimensionality of the new visualization | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | ID of the object | +**title** | str, | str, | Title of attribute. | +**type** | str, | str, | Object type | must be one of ["attribute", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/EntitySearchBody.md b/gooddata-api-client/docs/models/EntitySearchBody.md new file mode 100644 index 000000000..c1fb41048 --- /dev/null +++ b/gooddata-api-client/docs/models/EntitySearchBody.md @@ -0,0 +1,63 @@ +# gooddata_api_client.model.entity_search_body.EntitySearchBody + +Request body for entity search operations + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Request body for entity search operations | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**filter** | None, str, | NoneClass, str, | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] +**[include](#include)** | list, tuple, None, | tuple, NoneClass, | List of related entities to include in the response | [optional] +**[metaInclude](#metaInclude)** | list, tuple, None, | tuple, NoneClass, | Set of metadata fields to include in the response | [optional] +**page** | [**EntitySearchPage**](EntitySearchPage.md) | [**EntitySearchPage**](EntitySearchPage.md) | | [optional] +**[sort](#sort)** | list, tuple, None, | tuple, NoneClass, | Sorting criteria (can specify multiple sort orders) | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# include + +List of related entities to include in the response + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, None, | tuple, NoneClass, | List of related entities to include in the response | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# metaInclude + +Set of metadata fields to include in the response + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, None, | tuple, NoneClass, | Set of metadata fields to include in the response | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# sort + +Sorting criteria (can specify multiple sort orders) + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, None, | tuple, NoneClass, | Sorting criteria (can specify multiple sort orders) | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**EntitySearchSort**](EntitySearchSort.md) | [**EntitySearchSort**](EntitySearchSort.md) | [**EntitySearchSort**](EntitySearchSort.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/EntitySearchPage.md b/gooddata-api-client/docs/models/EntitySearchPage.md new file mode 100644 index 000000000..fc6472af4 --- /dev/null +++ b/gooddata-api-client/docs/models/EntitySearchPage.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.entity_search_page.EntitySearchPage + +Pagination information for entity search + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Pagination information for entity search | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**size** | decimal.Decimal, int, | decimal.Decimal, | Number of items per page | if omitted the server will use the default value of 100value must be a 32 bit integer +**index** | decimal.Decimal, int, | decimal.Decimal, | Zero-based page index | if omitted the server will use the default value of 0value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/EntitySearchSort.md b/gooddata-api-client/docs/models/EntitySearchSort.md new file mode 100644 index 000000000..52561dc8a --- /dev/null +++ b/gooddata-api-client/docs/models/EntitySearchSort.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.entity_search_sort.EntitySearchSort + +Sorting criteria for entity search + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Sorting criteria for entity search | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**property** | str, | str, | Property name to sort by | +**direction** | str, | str, | Sort direction | [optional] must be one of ["ASC", "DESC", ] if omitted the server will use the default value of "ASC" +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ExecutionResultDataSourceMessage.md b/gooddata-api-client/docs/models/ExecutionResultDataSourceMessage.md new file mode 100644 index 000000000..1b93100a3 --- /dev/null +++ b/gooddata-api-client/docs/models/ExecutionResultDataSourceMessage.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.execution_result_data_source_message.ExecutionResultDataSourceMessage + +A piece of extra information related to the results (e.g. debug information, warnings, etc.). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A piece of extra information related to the results (e.g. debug information, warnings, etc.). | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**correlationId** | str, | str, | Id correlating different pieces of supplementary info together. | +**source** | str, | str, | Information about what part of the system created this piece of supplementary info. | +**type** | str, | str, | Type of the supplementary info instance. There are currently no well-known values for this, but there might be some in the future. | +**[data](#data)** | dict, frozendict.frozendict, | frozendict.frozendict, | Data of this particular supplementary info item: a free-form JSON specific to the particular supplementary info item type. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +Data of this particular supplementary info item: a free-form JSON specific to the particular supplementary info item type. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Data of this particular supplementary info item: a free-form JSON specific to the particular supplementary info item type. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ExecutionResultMetadata.md b/gooddata-api-client/docs/models/ExecutionResultMetadata.md new file mode 100644 index 000000000..d87c6c8fa --- /dev/null +++ b/gooddata-api-client/docs/models/ExecutionResultMetadata.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.execution_result_metadata.ExecutionResultMetadata + +Additional metadata for the particular execution result. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Additional metadata for the particular execution result. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[dataSourceMessages](#dataSourceMessages)** | list, tuple, | tuple, | Additional information sent by the underlying data source. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dataSourceMessages + +Additional information sent by the underlying data source. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Additional information sent by the underlying data source. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ExecutionResultDataSourceMessage**](ExecutionResultDataSourceMessage.md) | [**ExecutionResultDataSourceMessage**](ExecutionResultDataSourceMessage.md) | [**ExecutionResultDataSourceMessage**](ExecutionResultDataSourceMessage.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ExportRequest.md b/gooddata-api-client/docs/models/ExportRequest.md new file mode 100644 index 000000000..5f5d7b75d --- /dev/null +++ b/gooddata-api-client/docs/models/ExportRequest.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.export_request.ExportRequest + +JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[VisualExportRequest](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | | +[TabularExportRequest](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ExportResult.md b/gooddata-api-client/docs/models/ExportResult.md new file mode 100644 index 000000000..6adef29cf --- /dev/null +++ b/gooddata-api-client/docs/models/ExportResult.md @@ -0,0 +1,23 @@ +# gooddata_api_client.model.export_result.ExportResult + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**fileName** | str, | str, | | +**exportId** | str, | str, | | +**status** | str, | str, | | must be one of ["SUCCESS", "ERROR", "INTERNAL_ERROR", "TIMEOUT", ] +**errorMessage** | str, | str, | | [optional] +**expiresAt** | str, datetime, | str, | | [optional] value must conform to RFC-3339 date-time +**fileSize** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 64 bit integer +**fileUri** | str, | str, | | [optional] +**traceId** | str, | str, | | [optional] +**triggeredAt** | str, datetime, | str, | | [optional] value must conform to RFC-3339 date-time +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/FactIdentifier.md b/gooddata-api-client/docs/models/FactIdentifier.md new file mode 100644 index 000000000..a1392f08f --- /dev/null +++ b/gooddata-api-client/docs/models/FactIdentifier.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.fact_identifier.FactIdentifier + +A fact identifier. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A fact identifier. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Fact ID. | +**type** | str, | str, | A type of the fact. | must be one of ["fact", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/FailedOperation.md b/gooddata-api-client/docs/models/FailedOperation.md new file mode 100644 index 000000000..57fcba920 --- /dev/null +++ b/gooddata-api-client/docs/models/FailedOperation.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.failed_operation.FailedOperation + +Operation that has failed + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Operation that has failed | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[Operation](Operation.md) | [**Operation**](Operation.md) | [**Operation**](Operation.md) | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**error** | [**OperationError**](OperationError.md) | [**OperationError**](OperationError.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/File.md b/gooddata-api-client/docs/models/File.md new file mode 100644 index 000000000..4fd46a4fc --- /dev/null +++ b/gooddata-api-client/docs/models/File.md @@ -0,0 +1,76 @@ +# gooddata_api_client.model.file.File + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[any](#any)** | list, tuple, | tuple, | | [optional] +**canResegment** | str, | str, | | [optional] must be one of ["YES", "NO", ] +**id** | str, | str, | | [optional] +**notes** | [**Notes**](Notes.md) | [**Notes**](Notes.md) | | [optional] +**original** | str, | str, | | [optional] +**[otherAttributes](#otherAttributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**skeleton** | [**Skeleton**](Skeleton.md) | [**Skeleton**](Skeleton.md) | | [optional] +**space** | str, | str, | | [optional] +**srcDir** | str, | str, | | [optional] must be one of ["LTR", "RTL", "AUTO", ] +**translate** | str, | str, | | [optional] must be one of ["YES", "NO", ] +**trgDir** | str, | str, | | [optional] must be one of ["LTR", "RTL", "AUTO", ] +**[unitOrGroup](#unitOrGroup)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# any + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +# otherAttributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional] + +# unitOrGroup + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Filter.md b/gooddata-api-client/docs/models/Filter.md new file mode 100644 index 000000000..ab21a7a4b --- /dev/null +++ b/gooddata-api-client/docs/models/Filter.md @@ -0,0 +1,11 @@ +# gooddata_api_client.model.filter.Filter + +List of filters to be applied to the new visualization + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | List of filters to be applied to the new visualization | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ForecastConfig.md b/gooddata-api-client/docs/models/ForecastConfig.md new file mode 100644 index 000000000..c263aa218 --- /dev/null +++ b/gooddata-api-client/docs/models/ForecastConfig.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.forecast_config.ForecastConfig + +Forecast configuration. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Forecast configuration. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**confidenceLevel** | decimal.Decimal, int, float, | decimal.Decimal, | Confidence interval boundary value. | value must be a 32 bit float +**seasonal** | bool, | BoolClass, | Whether the input data is seasonal | +**forecastPeriod** | decimal.Decimal, int, | decimal.Decimal, | Number of future periods that should be forecasted | value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ForecastRequest.md b/gooddata-api-client/docs/models/ForecastRequest.md new file mode 100644 index 000000000..a57756dad --- /dev/null +++ b/gooddata-api-client/docs/models/ForecastRequest.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.forecast_request.ForecastRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**forecastPeriod** | decimal.Decimal, int, | decimal.Decimal, | Number of future periods that should be forecasted | value must be a 32 bit integer +**confidenceLevel** | decimal.Decimal, int, float, | decimal.Decimal, | Confidence interval boundary value. | [optional] if omitted the server will use the default value of 0.95value must be a 32 bit float +**seasonal** | bool, | BoolClass, | Whether the input data is seasonal | [optional] if omitted the server will use the default value of False +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ForecastResult.md b/gooddata-api-client/docs/models/ForecastResult.md new file mode 100644 index 000000000..f6fb00861 --- /dev/null +++ b/gooddata-api-client/docs/models/ForecastResult.md @@ -0,0 +1,79 @@ +# gooddata_api_client.model.forecast_result.ForecastResult + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[upperBound](#upperBound)** | list, tuple, | tuple, | | +**[origin](#origin)** | list, tuple, | tuple, | | +**[prediction](#prediction)** | list, tuple, | tuple, | | +**[lowerBound](#lowerBound)** | list, tuple, | tuple, | | +**[attribute](#attribute)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attribute + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# lowerBound + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | None, decimal.Decimal, int, float, | NoneClass, decimal.Decimal, | | + +# origin + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | None, decimal.Decimal, int, float, | NoneClass, decimal.Decimal, | | + +# prediction + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | None, decimal.Decimal, int, float, | NoneClass, decimal.Decimal, | | + +# upperBound + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | None, decimal.Decimal, int, float, | NoneClass, decimal.Decimal, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/FoundObjects.md b/gooddata-api-client/docs/models/FoundObjects.md new file mode 100644 index 000000000..3c5b52077 --- /dev/null +++ b/gooddata-api-client/docs/models/FoundObjects.md @@ -0,0 +1,32 @@ +# gooddata_api_client.model.found_objects.FoundObjects + +List of objects found by similarity search and post-processed by LLM. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | List of objects found by similarity search and post-processed by LLM. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[objects](#objects)** | list, tuple, | tuple, | List of objects found with a similarity search. | +**reasoning** | str, | str, | DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# objects + +List of objects found with a similarity search. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of objects found with a similarity search. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**SearchResultObject**](SearchResultObject.md) | [**SearchResultObject**](SearchResultObject.md) | [**SearchResultObject**](SearchResultObject.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Frequency.md b/gooddata-api-client/docs/models/Frequency.md new file mode 100644 index 000000000..9158600e8 --- /dev/null +++ b/gooddata-api-client/docs/models/Frequency.md @@ -0,0 +1,27 @@ +# gooddata_api_client.model.frequency.Frequency + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[buckets](#buckets)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# buckets + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**FrequencyBucket**](FrequencyBucket.md) | [**FrequencyBucket**](FrequencyBucket.md) | [**FrequencyBucket**](FrequencyBucket.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/FrequencyBucket.md b/gooddata-api-client/docs/models/FrequencyBucket.md new file mode 100644 index 000000000..d0f4f2f4a --- /dev/null +++ b/gooddata-api-client/docs/models/FrequencyBucket.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.frequency_bucket.FrequencyBucket + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**count** | decimal.Decimal, int, | decimal.Decimal, | | value must be a 64 bit integer +**value** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/FrequencyProperties.md b/gooddata-api-client/docs/models/FrequencyProperties.md new file mode 100644 index 000000000..3866e75d3 --- /dev/null +++ b/gooddata-api-client/docs/models/FrequencyProperties.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.frequency_properties.FrequencyProperties + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**valueLimit** | decimal.Decimal, int, | decimal.Decimal, | The maximum number of distinct values to return. | [optional] if omitted the server will use the default value of 10value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/GenerateDescriptionRequest.md b/gooddata-api-client/docs/models/GenerateDescriptionRequest.md new file mode 100644 index 000000000..3b1fad96b --- /dev/null +++ b/gooddata-api-client/docs/models/GenerateDescriptionRequest.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.generate_description_request.GenerateDescriptionRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**objectId** | str, | str, | Identifier of the object to describe | +**objectType** | str, | str, | Type of the object to describe. One of: visualization, dashboard, metric, fact, attribute | must be one of ["Visualization", "Dashboard", "Metric", "Fact", "Attribute", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/GenerateDescriptionResponse.md b/gooddata-api-client/docs/models/GenerateDescriptionResponse.md new file mode 100644 index 000000000..464cc6a6d --- /dev/null +++ b/gooddata-api-client/docs/models/GenerateDescriptionResponse.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.generate_description_response.GenerateDescriptionResponse + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**description** | str, | str, | Generated description of the requested object | [optional] +**note** | str, | str, | Additional note with details in case generation was not performed | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/GenerateTitleRequest.md b/gooddata-api-client/docs/models/GenerateTitleRequest.md new file mode 100644 index 000000000..f0757b7c7 --- /dev/null +++ b/gooddata-api-client/docs/models/GenerateTitleRequest.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.generate_title_request.GenerateTitleRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**objectId** | str, | str, | Identifier of the object to title | +**objectType** | str, | str, | Type of the object to title. Matches chat-search object types. | must be one of ["Visualization", "Dashboard", "Metric", "Fact", "Attribute", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/GenerateTitleResponse.md b/gooddata-api-client/docs/models/GenerateTitleResponse.md new file mode 100644 index 000000000..10aad53b8 --- /dev/null +++ b/gooddata-api-client/docs/models/GenerateTitleResponse.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.generate_title_response.GenerateTitleResponse + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**note** | str, | str, | Additional note with details in case generation was not performed | [optional] +**title** | str, | str, | Generated title of the requested object | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/GeoAreaConfig.md b/gooddata-api-client/docs/models/GeoAreaConfig.md new file mode 100644 index 000000000..8e10421ab --- /dev/null +++ b/gooddata-api-client/docs/models/GeoAreaConfig.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.geo_area_config.GeoAreaConfig + +Configuration specific to geo area labels. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Configuration specific to geo area labels. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**collection** | [**GeoCollectionIdentifier**](GeoCollectionIdentifier.md) | [**GeoCollectionIdentifier**](GeoCollectionIdentifier.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/GeoCollectionIdentifier.md b/gooddata-api-client/docs/models/GeoCollectionIdentifier.md new file mode 100644 index 000000000..fc9f06f99 --- /dev/null +++ b/gooddata-api-client/docs/models/GeoCollectionIdentifier.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.geo_collection_identifier.GeoCollectionIdentifier + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Geo collection identifier. | +**kind** | str, | str, | Type of geo collection. | [optional] must be one of ["STATIC", "CUSTOM", ] if omitted the server will use the default value of "STATIC" +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/GetQualityIssuesResponse.md b/gooddata-api-client/docs/models/GetQualityIssuesResponse.md new file mode 100644 index 000000000..e420797e5 --- /dev/null +++ b/gooddata-api-client/docs/models/GetQualityIssuesResponse.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.get_quality_issues_response.GetQualityIssuesResponse + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[issues](#issues)** | list, tuple, | tuple, | List of quality issues found in the workspace | +**status** | str, | str, | Status of the latest triggered quality check process | must be one of ["RUNNING", "SYNCING", "COMPLETED", "FAILED", "CANCELLED", "NOT_FOUND", "DISABLED", ] +**updatedAt** | str, | str, | Timestamp when the quality issues were last updated (ISO format) | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# issues + +List of quality issues found in the workspace + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of quality issues found in the workspace | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**QualityIssue**](QualityIssue.md) | [**QualityIssue**](QualityIssue.md) | [**QualityIssue**](QualityIssue.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Histogram.md b/gooddata-api-client/docs/models/Histogram.md new file mode 100644 index 000000000..c517979f3 --- /dev/null +++ b/gooddata-api-client/docs/models/Histogram.md @@ -0,0 +1,27 @@ +# gooddata_api_client.model.histogram.Histogram + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[buckets](#buckets)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# buckets + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**HistogramBucket**](HistogramBucket.md) | [**HistogramBucket**](HistogramBucket.md) | [**HistogramBucket**](HistogramBucket.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/HistogramBucket.md b/gooddata-api-client/docs/models/HistogramBucket.md new file mode 100644 index 000000000..88ce1d400 --- /dev/null +++ b/gooddata-api-client/docs/models/HistogramBucket.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.histogram_bucket.HistogramBucket + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**upperBound** | decimal.Decimal, int, float, | decimal.Decimal, | | value must be a 64 bit float +**count** | decimal.Decimal, int, | decimal.Decimal, | | value must be a 64 bit integer +**lowerBound** | decimal.Decimal, int, float, | decimal.Decimal, | | value must be a 64 bit float +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/HistogramProperties.md b/gooddata-api-client/docs/models/HistogramProperties.md new file mode 100644 index 000000000..a5ff4ed3d --- /dev/null +++ b/gooddata-api-client/docs/models/HistogramProperties.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.histogram_properties.HistogramProperties + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**bucketCount** | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/IdentifierRef.md b/gooddata-api-client/docs/models/IdentifierRef.md new file mode 100644 index 000000000..23644e9de --- /dev/null +++ b/gooddata-api-client/docs/models/IdentifierRef.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.identifier_ref.IdentifierRef + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[identifier](#identifier)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# identifier + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**type** | str, | str, | | must be one of ["analyticalDashboard", "attribute", "attributeHierarchy", "dashboardPlugin", "dataset", "fact", "aggregatedFact", "label", "metric", "userDataFilter", "exportDefinition", "automation", "automationResult", "memoryItem", "knowledgeRecommendation", "prompt", "visualizationObject", "filterContext", "workspaceSettings", "customApplicationSetting", "workspaceDataFilter", "workspaceDataFilterSetting", "filterView", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ImageExportRequest.md b/gooddata-api-client/docs/models/ImageExportRequest.md new file mode 100644 index 000000000..ca8759f04 --- /dev/null +++ b/gooddata-api-client/docs/models/ImageExportRequest.md @@ -0,0 +1,35 @@ +# gooddata_api_client.model.image_export_request.ImageExportRequest + +Export request object describing the export properties and metadata for image exports. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Export request object describing the export properties and metadata for image exports. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**fileName** | str, | str, | File name to be used for retrieving the image document. | +**dashboardId** | str, | str, | Dashboard identifier | +**[widgetIds](#widgetIds)** | list, tuple, | tuple, | List of widget identifiers to be exported. Note that only one widget is currently supported. | +**format** | str, | str, | Requested resulting file type. | must be one of ["PNG", ] +**metadata** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# widgetIds + +List of widget identifiers to be exported. Note that only one widget is currently supported. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of widget identifiers to be exported. Note that only one widget is currently supported. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/InPlatform.md b/gooddata-api-client/docs/models/InPlatform.md new file mode 100644 index 000000000..aebb5bb97 --- /dev/null +++ b/gooddata-api-client/docs/models/InPlatform.md @@ -0,0 +1,36 @@ +# gooddata_api_client.model.in_platform.InPlatform + +In-platform destination for notifications. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | In-platform destination for notifications. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**type** | str, | str, | The destination type. | must be one of ["IN_PLATFORM", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**type** | str, | str, | The destination type. | [optional] must be one of ["IN_PLATFORM", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/IntroSlideTemplate.md b/gooddata-api-client/docs/models/IntroSlideTemplate.md new file mode 100644 index 000000000..2036dc7ee --- /dev/null +++ b/gooddata-api-client/docs/models/IntroSlideTemplate.md @@ -0,0 +1,21 @@ +# gooddata_api_client.model.intro_slide_template.IntroSlideTemplate + +Settings for intro slide. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Settings for intro slide. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**backgroundImage** | bool, | BoolClass, | Show background image on the slide. | [optional] if omitted the server will use the default value of True +**descriptionField** | None, str, | NoneClass, str, | | [optional] +**footer** | [**RunningSection**](RunningSection.md) | [**RunningSection**](RunningSection.md) | | [optional] +**header** | [**RunningSection**](RunningSection.md) | [**RunningSection**](RunningSection.md) | | [optional] +**titleField** | None, str, | NoneClass, str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAggregatedFactLinkage.md b/gooddata-api-client/docs/models/JsonApiAggregatedFactLinkage.md new file mode 100644 index 000000000..a664d8915 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAggregatedFactLinkage.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.json_api_aggregated_fact_linkage.JsonApiAggregatedFactLinkage + +The \\\"type\\\" and \\\"id\\\" to non-empty members. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | The \\\"type\\\" and \\\"id\\\" to non-empty members. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**type** | str, | str, | | must be one of ["aggregatedFact", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAggregatedFactOut.md b/gooddata-api-client/docs/models/JsonApiAggregatedFactOut.md new file mode 100644 index 000000000..0312ab2c7 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAggregatedFactOut.md @@ -0,0 +1,120 @@ +# gooddata_api_client.model.json_api_aggregated_fact_out.JsonApiAggregatedFactOut + +JSON:API representation of aggregatedFact entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of aggregatedFact entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["aggregatedFact", ] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**operation** | str, | str, | | must be one of ["SUM", "MIN", "MAX", ] +**areRelationsValid** | bool, | BoolClass, | | [optional] +**description** | str, | str, | | [optional] +**isNullable** | bool, | BoolClass, | | [optional] +**nullValue** | str, | str, | | [optional] +**sourceColumn** | str, | str, | | [optional] +**sourceColumnDataType** | str, | str, | | [optional] must be one of ["INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", ] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[origin](#origin)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# origin + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**originType** | str, | str, | defines type of the origin of the entity | must be one of ["NATIVE", "PARENT", ] +**originId** | str, | str, | defines id of the workspace where the entity comes from | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[dataset](#dataset)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[sourceFact](#sourceFact)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dataset + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiDatasetToOneLinkage**](JsonApiDatasetToOneLinkage.md) | [**JsonApiDatasetToOneLinkage**](JsonApiDatasetToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# sourceFact + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiFactToOneLinkage**](JsonApiFactToOneLinkage.md) | [**JsonApiFactToOneLinkage**](JsonApiFactToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAggregatedFactOutDocument.md b/gooddata-api-client/docs/models/JsonApiAggregatedFactOutDocument.md new file mode 100644 index 000000000..0e4b159b0 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAggregatedFactOutDocument.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.json_api_aggregated_fact_out_document.JsonApiAggregatedFactOutDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAggregatedFactOut**](JsonApiAggregatedFactOut.md) | [**JsonApiAggregatedFactOut**](JsonApiAggregatedFactOut.md) | | +**[included](#included)** | list, tuple, | tuple, | Included resources | [optional] +**links** | [**ObjectLinks**](ObjectLinks.md) | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# included + +Included resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included resources | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiAggregatedFactOutIncludes**](JsonApiAggregatedFactOutIncludes.md) | [**JsonApiAggregatedFactOutIncludes**](JsonApiAggregatedFactOutIncludes.md) | [**JsonApiAggregatedFactOutIncludes**](JsonApiAggregatedFactOutIncludes.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAggregatedFactOutIncludes.md b/gooddata-api-client/docs/models/JsonApiAggregatedFactOutIncludes.md new file mode 100644 index 000000000..edf1f3777 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAggregatedFactOutIncludes.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_aggregated_fact_out_includes.JsonApiAggregatedFactOutIncludes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiDatasetOutWithLinks](JsonApiDatasetOutWithLinks.md) | [**JsonApiDatasetOutWithLinks**](JsonApiDatasetOutWithLinks.md) | [**JsonApiDatasetOutWithLinks**](JsonApiDatasetOutWithLinks.md) | | +[JsonApiFactOutWithLinks](JsonApiFactOutWithLinks.md) | [**JsonApiFactOutWithLinks**](JsonApiFactOutWithLinks.md) | [**JsonApiFactOutWithLinks**](JsonApiFactOutWithLinks.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAggregatedFactOutList.md b/gooddata-api-client/docs/models/JsonApiAggregatedFactOutList.md new file mode 100644 index 000000000..380f454b6 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAggregatedFactOutList.md @@ -0,0 +1,59 @@ +# gooddata_api_client.model.json_api_aggregated_fact_out_list.JsonApiAggregatedFactOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**[included](#included)** | list, tuple, | tuple, | Included resources | [optional] +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiAggregatedFactOutWithLinks**](JsonApiAggregatedFactOutWithLinks.md) | [**JsonApiAggregatedFactOutWithLinks**](JsonApiAggregatedFactOutWithLinks.md) | [**JsonApiAggregatedFactOutWithLinks**](JsonApiAggregatedFactOutWithLinks.md) | | + +# included + +Included resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included resources | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiAggregatedFactOutIncludes**](JsonApiAggregatedFactOutIncludes.md) | [**JsonApiAggregatedFactOutIncludes**](JsonApiAggregatedFactOutIncludes.md) | [**JsonApiAggregatedFactOutIncludes**](JsonApiAggregatedFactOutIncludes.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAggregatedFactOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiAggregatedFactOutWithLinks.md new file mode 100644 index 000000000..22aed9390 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAggregatedFactOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_aggregated_fact_out_with_links.JsonApiAggregatedFactOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiAggregatedFactOut](JsonApiAggregatedFactOut.md) | [**JsonApiAggregatedFactOut**](JsonApiAggregatedFactOut.md) | [**JsonApiAggregatedFactOut**](JsonApiAggregatedFactOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAggregatedFactToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiAggregatedFactToManyLinkage.md new file mode 100644 index 000000000..bc052c99f --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAggregatedFactToManyLinkage.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_aggregated_fact_to_many_linkage.JsonApiAggregatedFactToManyLinkage + +References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiAggregatedFactLinkage**](JsonApiAggregatedFactLinkage.md) | [**JsonApiAggregatedFactLinkage**](JsonApiAggregatedFactLinkage.md) | [**JsonApiAggregatedFactLinkage**](JsonApiAggregatedFactLinkage.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardToOneLinkage.md b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardToOneLinkage.md new file mode 100644 index 000000000..63e5e5498 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAnalyticalDashboardToOneLinkage.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage.JsonApiAnalyticalDashboardToOneLinkage + +References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiAnalyticalDashboardLinkage](JsonApiAnalyticalDashboardLinkage.md) | [**JsonApiAnalyticalDashboardLinkage**](JsonApiAnalyticalDashboardLinkage.md) | [**JsonApiAnalyticalDashboardLinkage**](JsonApiAnalyticalDashboardLinkage.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAttributeHierarchyIn.md b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyIn.md new file mode 100644 index 000000000..08e8c921f --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyIn.md @@ -0,0 +1,57 @@ +# gooddata_api_client.model.json_api_attribute_hierarchy_in.JsonApiAttributeHierarchyIn + +JSON:API representation of attributeHierarchy entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of attributeHierarchy entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["attributeHierarchy", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**areRelationsValid** | bool, | BoolClass, | | [optional] +**[content](#content)** | dict, frozendict.frozendict, | frozendict.frozendict, | Free-form JSON content. Maximum supported length is 15000 characters. | [optional] +**description** | str, | str, | | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# content + +Free-form JSON content. Maximum supported length is 15000 characters. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Free-form JSON content. Maximum supported length is 15000 characters. | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAttributeHierarchyInDocument.md b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyInDocument.md new file mode 100644 index 000000000..48a11b95f --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyInDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_attribute_hierarchy_in_document.JsonApiAttributeHierarchyInDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAttributeHierarchyIn**](JsonApiAttributeHierarchyIn.md) | [**JsonApiAttributeHierarchyIn**](JsonApiAttributeHierarchyIn.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAttributeHierarchyLinkage.md b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyLinkage.md new file mode 100644 index 000000000..aa61b654d --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyLinkage.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.json_api_attribute_hierarchy_linkage.JsonApiAttributeHierarchyLinkage + +The \\\"type\\\" and \\\"id\\\" to non-empty members. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | The \\\"type\\\" and \\\"id\\\" to non-empty members. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**type** | str, | str, | | must be one of ["attributeHierarchy", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAttributeHierarchyOut.md b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyOut.md new file mode 100644 index 000000000..490b26cfd --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyOut.md @@ -0,0 +1,142 @@ +# gooddata_api_client.model.json_api_attribute_hierarchy_out.JsonApiAttributeHierarchyOut + +JSON:API representation of attributeHierarchy entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of attributeHierarchy entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["attributeHierarchy", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**areRelationsValid** | bool, | BoolClass, | | [optional] +**[content](#content)** | dict, frozendict.frozendict, | frozendict.frozendict, | Free-form JSON content. Maximum supported length is 15000 characters. | [optional] +**createdAt** | None, str, datetime, | NoneClass, str, | Time of the entity creation. | [optional] value must conform to RFC-3339 date-time +**description** | str, | str, | | [optional] +**modifiedAt** | None, str, datetime, | NoneClass, str, | Time of the last entity modification. | [optional] value must conform to RFC-3339 date-time +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# content + +Free-form JSON content. Maximum supported length is 15000 characters. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Free-form JSON content. Maximum supported length is 15000 characters. | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[origin](#origin)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# origin + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**originType** | str, | str, | defines type of the origin of the entity | must be one of ["NATIVE", "PARENT", ] +**originId** | str, | str, | defines id of the workspace where the entity comes from | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[createdBy](#createdBy)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[modifiedBy](#modifiedBy)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAttributeToManyLinkage**](JsonApiAttributeToManyLinkage.md) | [**JsonApiAttributeToManyLinkage**](JsonApiAttributeToManyLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# createdBy + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# modifiedBy + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAttributeHierarchyOutDocument.md b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyOutDocument.md new file mode 100644 index 000000000..914fbec80 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyOutDocument.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.json_api_attribute_hierarchy_out_document.JsonApiAttributeHierarchyOutDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAttributeHierarchyOut**](JsonApiAttributeHierarchyOut.md) | [**JsonApiAttributeHierarchyOut**](JsonApiAttributeHierarchyOut.md) | | +**[included](#included)** | list, tuple, | tuple, | Included resources | [optional] +**links** | [**ObjectLinks**](ObjectLinks.md) | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# included + +Included resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included resources | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyOutIncludes**](JsonApiAttributeHierarchyOutIncludes.md) | [**JsonApiAttributeHierarchyOutIncludes**](JsonApiAttributeHierarchyOutIncludes.md) | [**JsonApiAttributeHierarchyOutIncludes**](JsonApiAttributeHierarchyOutIncludes.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAttributeHierarchyOutIncludes.md b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyOutIncludes.md new file mode 100644 index 000000000..cecae7bba --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyOutIncludes.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_attribute_hierarchy_out_includes.JsonApiAttributeHierarchyOutIncludes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiUserIdentifierOutWithLinks](JsonApiUserIdentifierOutWithLinks.md) | [**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | [**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | | +[JsonApiAttributeOutWithLinks](JsonApiAttributeOutWithLinks.md) | [**JsonApiAttributeOutWithLinks**](JsonApiAttributeOutWithLinks.md) | [**JsonApiAttributeOutWithLinks**](JsonApiAttributeOutWithLinks.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAttributeHierarchyOutList.md b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyOutList.md new file mode 100644 index 000000000..f5fe24ce4 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyOutList.md @@ -0,0 +1,59 @@ +# gooddata_api_client.model.json_api_attribute_hierarchy_out_list.JsonApiAttributeHierarchyOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**[included](#included)** | list, tuple, | tuple, | Included resources | [optional] +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyOutWithLinks**](JsonApiAttributeHierarchyOutWithLinks.md) | [**JsonApiAttributeHierarchyOutWithLinks**](JsonApiAttributeHierarchyOutWithLinks.md) | [**JsonApiAttributeHierarchyOutWithLinks**](JsonApiAttributeHierarchyOutWithLinks.md) | | + +# included + +Included resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included resources | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyOutIncludes**](JsonApiAttributeHierarchyOutIncludes.md) | [**JsonApiAttributeHierarchyOutIncludes**](JsonApiAttributeHierarchyOutIncludes.md) | [**JsonApiAttributeHierarchyOutIncludes**](JsonApiAttributeHierarchyOutIncludes.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAttributeHierarchyOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyOutWithLinks.md new file mode 100644 index 000000000..89e023227 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_attribute_hierarchy_out_with_links.JsonApiAttributeHierarchyOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiAttributeHierarchyOut](JsonApiAttributeHierarchyOut.md) | [**JsonApiAttributeHierarchyOut**](JsonApiAttributeHierarchyOut.md) | [**JsonApiAttributeHierarchyOut**](JsonApiAttributeHierarchyOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAttributeHierarchyPatch.md b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyPatch.md new file mode 100644 index 000000000..48dcb8ef7 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyPatch.md @@ -0,0 +1,57 @@ +# gooddata_api_client.model.json_api_attribute_hierarchy_patch.JsonApiAttributeHierarchyPatch + +JSON:API representation of patching attributeHierarchy entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching attributeHierarchy entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["attributeHierarchy", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**areRelationsValid** | bool, | BoolClass, | | [optional] +**[content](#content)** | dict, frozendict.frozendict, | frozendict.frozendict, | Free-form JSON content. Maximum supported length is 15000 characters. | [optional] +**description** | str, | str, | | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# content + +Free-form JSON content. Maximum supported length is 15000 characters. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Free-form JSON content. Maximum supported length is 15000 characters. | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAttributeHierarchyPatchDocument.md b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyPatchDocument.md new file mode 100644 index 000000000..430f5a6a0 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyPatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_attribute_hierarchy_patch_document.JsonApiAttributeHierarchyPatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAttributeHierarchyPatch**](JsonApiAttributeHierarchyPatch.md) | [**JsonApiAttributeHierarchyPatch**](JsonApiAttributeHierarchyPatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAttributeHierarchyToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyToManyLinkage.md new file mode 100644 index 000000000..bf1d6da87 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAttributeHierarchyToManyLinkage.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_attribute_hierarchy_to_many_linkage.JsonApiAttributeHierarchyToManyLinkage + +References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiAttributeHierarchyLinkage**](JsonApiAttributeHierarchyLinkage.md) | [**JsonApiAttributeHierarchyLinkage**](JsonApiAttributeHierarchyLinkage.md) | [**JsonApiAttributeHierarchyLinkage**](JsonApiAttributeHierarchyLinkage.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAttributePatch.md b/gooddata-api-client/docs/models/JsonApiAttributePatch.md new file mode 100644 index 000000000..ab33f5a25 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAttributePatch.md @@ -0,0 +1,73 @@ +# gooddata_api_client.model.json_api_attribute_patch.JsonApiAttributePatch + +JSON:API representation of patching attribute entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching attribute entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["attribute", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**description** | str, | str, | | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[defaultView](#defaultView)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# defaultView + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiLabelToOneLinkage**](JsonApiLabelToOneLinkage.md) | [**JsonApiLabelToOneLinkage**](JsonApiLabelToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAttributePatchDocument.md b/gooddata-api-client/docs/models/JsonApiAttributePatchDocument.md new file mode 100644 index 000000000..4b1ef387e --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAttributePatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_attribute_patch_document.JsonApiAttributePatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAttributePatch**](JsonApiAttributePatch.md) | [**JsonApiAttributePatch**](JsonApiAttributePatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAutomationIn.md b/gooddata-api-client/docs/models/JsonApiAutomationIn.md new file mode 100644 index 000000000..d3d3f00b7 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAutomationIn.md @@ -0,0 +1,375 @@ +# gooddata_api_client.model.json_api_automation_in.JsonApiAutomationIn + +JSON:API representation of automation entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of automation entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["automation", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[alert](#alert)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**areRelationsValid** | bool, | BoolClass, | | [optional] +**[dashboardTabularExports](#dashboardTabularExports)** | list, tuple, | tuple, | | [optional] +**description** | str, | str, | | [optional] +**[details](#details)** | dict, frozendict.frozendict, | frozendict.frozendict, | Additional details to be included in the automated message. | [optional] +**evaluationMode** | str, | str, | Specify automation evaluation mode. | [optional] must be one of ["SHARED", "PER_RECIPIENT", ] +**[externalRecipients](#externalRecipients)** | list, tuple, | tuple, | External recipients of the automation action results. | [optional] +**[imageExports](#imageExports)** | list, tuple, | tuple, | | [optional] +**[metadata](#metadata)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Additional information for the automation. | [optional] +**[rawExports](#rawExports)** | list, tuple, | tuple, | | [optional] +**[schedule](#schedule)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[slidesExports](#slidesExports)** | list, tuple, | tuple, | | [optional] +**state** | str, | str, | Current state of the automation. | [optional] must be one of ["ACTIVE", "PAUSED", ] +**[tabularExports](#tabularExports)** | list, tuple, | tuple, | | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**[visualExports](#visualExports)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# alert + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**execution** | [**AlertAfm**](AlertAfm.md) | [**AlertAfm**](AlertAfm.md) | | +**condition** | [**AlertCondition**](AlertCondition.md) | [**AlertCondition**](AlertCondition.md) | | +**interval** | str, | str, | Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR. | [optional] must be one of ["DAY", "WEEK", "MONTH", "QUARTER", "YEAR", ] +**trigger** | str, | 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] must be one of ["ALWAYS", "ONCE", "ONCE_PER_INTERVAL", ] if omitted the server will use the default value of "ALWAYS" +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dashboardTabularExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**DashboardTabularExportRequestV2**](DashboardTabularExportRequestV2.md) | [**DashboardTabularExportRequestV2**](DashboardTabularExportRequestV2.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# details + +Additional details to be included in the automated message. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Additional details to be included in the automated message. | + +# externalRecipients + +External recipients of the automation action results. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | External recipients of the automation action results. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**email** | str, | str, | E-mail address to send notifications from. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# imageExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**ImageExportRequest**](ImageExportRequest.md) | [**ImageExportRequest**](ImageExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# metadata + +Additional information for the automation. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Additional information for the automation. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[visibleFilters](#visibleFilters)** | list, tuple, | tuple, | | [optional] +**widget** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# visibleFilters + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**VisibleFilter**](VisibleFilter.md) | [**VisibleFilter**](VisibleFilter.md) | [**VisibleFilter**](VisibleFilter.md) | | + +# rawExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**RawExportAutomationRequest**](RawExportAutomationRequest.md) | [**RawExportAutomationRequest**](RawExportAutomationRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# schedule + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**cron** | str, | str, | 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. | +**timezone** | str, | str, | Timezone in which the schedule is defined. | +**cronDescription** | str, | str, | Human-readable description of the cron expression. | [optional] +**firstRun** | str, datetime, | str, | Timestamp of the first scheduled action. If not provided default to the next scheduled time. | [optional] value must conform to RFC-3339 date-time +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# slidesExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**SlidesExportRequest**](SlidesExportRequest.md) | [**SlidesExportRequest**](SlidesExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tabularExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**TabularExportRequest**](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# visualExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**VisualExportRequest**](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[analyticalDashboard](#analyticalDashboard)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[exportDefinitions](#exportDefinitions)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[notificationChannel](#notificationChannel)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[recipients](#recipients)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# analyticalDashboard + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# exportDefinitions + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiExportDefinitionToManyLinkage**](JsonApiExportDefinitionToManyLinkage.md) | [**JsonApiExportDefinitionToManyLinkage**](JsonApiExportDefinitionToManyLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# notificationChannel + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiNotificationChannelToOneLinkage**](JsonApiNotificationChannelToOneLinkage.md) | [**JsonApiNotificationChannelToOneLinkage**](JsonApiNotificationChannelToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# recipients + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserToManyLinkage**](JsonApiUserToManyLinkage.md) | [**JsonApiUserToManyLinkage**](JsonApiUserToManyLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAutomationInDocument.md b/gooddata-api-client/docs/models/JsonApiAutomationInDocument.md new file mode 100644 index 000000000..dbcb271d5 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAutomationInDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_automation_in_document.JsonApiAutomationInDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAutomationIn**](JsonApiAutomationIn.md) | [**JsonApiAutomationIn**](JsonApiAutomationIn.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAutomationLinkage.md b/gooddata-api-client/docs/models/JsonApiAutomationLinkage.md new file mode 100644 index 000000000..cbee725b1 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAutomationLinkage.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.json_api_automation_linkage.JsonApiAutomationLinkage + +The \\\"type\\\" and \\\"id\\\" to non-empty members. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | The \\\"type\\\" and \\\"id\\\" to non-empty members. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**type** | str, | str, | | must be one of ["automation", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAutomationOut.md b/gooddata-api-client/docs/models/JsonApiAutomationOut.md new file mode 100644 index 000000000..f501159a9 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAutomationOut.md @@ -0,0 +1,447 @@ +# gooddata_api_client.model.json_api_automation_out.JsonApiAutomationOut + +JSON:API representation of automation entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of automation entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["automation", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[alert](#alert)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**areRelationsValid** | bool, | BoolClass, | | [optional] +**createdAt** | None, str, datetime, | NoneClass, str, | Time of the entity creation. | [optional] value must conform to RFC-3339 date-time +**[dashboardTabularExports](#dashboardTabularExports)** | list, tuple, | tuple, | | [optional] +**description** | str, | str, | | [optional] +**[details](#details)** | dict, frozendict.frozendict, | frozendict.frozendict, | Additional details to be included in the automated message. | [optional] +**evaluationMode** | str, | str, | Specify automation evaluation mode. | [optional] must be one of ["SHARED", "PER_RECIPIENT", ] +**[externalRecipients](#externalRecipients)** | list, tuple, | tuple, | External recipients of the automation action results. | [optional] +**[imageExports](#imageExports)** | list, tuple, | tuple, | | [optional] +**[metadata](#metadata)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Additional information for the automation. | [optional] +**modifiedAt** | None, str, datetime, | NoneClass, str, | Time of the last entity modification. | [optional] value must conform to RFC-3339 date-time +**[rawExports](#rawExports)** | list, tuple, | tuple, | | [optional] +**[schedule](#schedule)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[slidesExports](#slidesExports)** | list, tuple, | tuple, | | [optional] +**state** | str, | str, | Current state of the automation. | [optional] must be one of ["ACTIVE", "PAUSED", ] +**[tabularExports](#tabularExports)** | list, tuple, | tuple, | | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**[visualExports](#visualExports)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# alert + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**execution** | [**AlertAfm**](AlertAfm.md) | [**AlertAfm**](AlertAfm.md) | | +**condition** | [**AlertCondition**](AlertCondition.md) | [**AlertCondition**](AlertCondition.md) | | +**interval** | str, | str, | Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR. | [optional] must be one of ["DAY", "WEEK", "MONTH", "QUARTER", "YEAR", ] +**trigger** | str, | 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] must be one of ["ALWAYS", "ONCE", "ONCE_PER_INTERVAL", ] if omitted the server will use the default value of "ALWAYS" +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dashboardTabularExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**DashboardTabularExportRequestV2**](DashboardTabularExportRequestV2.md) | [**DashboardTabularExportRequestV2**](DashboardTabularExportRequestV2.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# details + +Additional details to be included in the automated message. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Additional details to be included in the automated message. | + +# externalRecipients + +External recipients of the automation action results. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | External recipients of the automation action results. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**email** | str, | str, | E-mail address to send notifications from. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# imageExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**ImageExportRequest**](ImageExportRequest.md) | [**ImageExportRequest**](ImageExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# metadata + +Additional information for the automation. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Additional information for the automation. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[visibleFilters](#visibleFilters)** | list, tuple, | tuple, | | [optional] +**widget** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# visibleFilters + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**VisibleFilter**](VisibleFilter.md) | [**VisibleFilter**](VisibleFilter.md) | [**VisibleFilter**](VisibleFilter.md) | | + +# rawExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**RawExportAutomationRequest**](RawExportAutomationRequest.md) | [**RawExportAutomationRequest**](RawExportAutomationRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# schedule + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**cron** | str, | str, | 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. | +**timezone** | str, | str, | Timezone in which the schedule is defined. | +**cronDescription** | str, | str, | Human-readable description of the cron expression. | [optional] +**firstRun** | str, datetime, | str, | Timestamp of the first scheduled action. If not provided default to the next scheduled time. | [optional] value must conform to RFC-3339 date-time +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# slidesExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**SlidesExportRequest**](SlidesExportRequest.md) | [**SlidesExportRequest**](SlidesExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tabularExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**TabularExportRequest**](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# visualExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**VisualExportRequest**](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[origin](#origin)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# origin + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**originType** | str, | str, | defines type of the origin of the entity | must be one of ["NATIVE", "PARENT", ] +**originId** | str, | str, | defines id of the workspace where the entity comes from | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[analyticalDashboard](#analyticalDashboard)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[automationResults](#automationResults)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[createdBy](#createdBy)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[exportDefinitions](#exportDefinitions)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[modifiedBy](#modifiedBy)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[notificationChannel](#notificationChannel)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[recipients](#recipients)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# analyticalDashboard + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# automationResults + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAutomationResultToManyLinkage**](JsonApiAutomationResultToManyLinkage.md) | [**JsonApiAutomationResultToManyLinkage**](JsonApiAutomationResultToManyLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# createdBy + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# exportDefinitions + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiExportDefinitionToManyLinkage**](JsonApiExportDefinitionToManyLinkage.md) | [**JsonApiExportDefinitionToManyLinkage**](JsonApiExportDefinitionToManyLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# modifiedBy + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# notificationChannel + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiNotificationChannelToOneLinkage**](JsonApiNotificationChannelToOneLinkage.md) | [**JsonApiNotificationChannelToOneLinkage**](JsonApiNotificationChannelToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# recipients + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserToManyLinkage**](JsonApiUserToManyLinkage.md) | [**JsonApiUserToManyLinkage**](JsonApiUserToManyLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAutomationOutDocument.md b/gooddata-api-client/docs/models/JsonApiAutomationOutDocument.md new file mode 100644 index 000000000..8f98f9416 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAutomationOutDocument.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.json_api_automation_out_document.JsonApiAutomationOutDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAutomationOut**](JsonApiAutomationOut.md) | [**JsonApiAutomationOut**](JsonApiAutomationOut.md) | | +**[included](#included)** | list, tuple, | tuple, | Included resources | [optional] +**links** | [**ObjectLinks**](ObjectLinks.md) | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# included + +Included resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included resources | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiAutomationOutIncludes**](JsonApiAutomationOutIncludes.md) | [**JsonApiAutomationOutIncludes**](JsonApiAutomationOutIncludes.md) | [**JsonApiAutomationOutIncludes**](JsonApiAutomationOutIncludes.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAutomationOutIncludes.md b/gooddata-api-client/docs/models/JsonApiAutomationOutIncludes.md new file mode 100644 index 000000000..bfc9b9744 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAutomationOutIncludes.md @@ -0,0 +1,20 @@ +# gooddata_api_client.model.json_api_automation_out_includes.JsonApiAutomationOutIncludes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiNotificationChannelOutWithLinks](JsonApiNotificationChannelOutWithLinks.md) | [**JsonApiNotificationChannelOutWithLinks**](JsonApiNotificationChannelOutWithLinks.md) | [**JsonApiNotificationChannelOutWithLinks**](JsonApiNotificationChannelOutWithLinks.md) | | +[JsonApiAnalyticalDashboardOutWithLinks](JsonApiAnalyticalDashboardOutWithLinks.md) | [**JsonApiAnalyticalDashboardOutWithLinks**](JsonApiAnalyticalDashboardOutWithLinks.md) | [**JsonApiAnalyticalDashboardOutWithLinks**](JsonApiAnalyticalDashboardOutWithLinks.md) | | +[JsonApiUserIdentifierOutWithLinks](JsonApiUserIdentifierOutWithLinks.md) | [**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | [**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | | +[JsonApiExportDefinitionOutWithLinks](JsonApiExportDefinitionOutWithLinks.md) | [**JsonApiExportDefinitionOutWithLinks**](JsonApiExportDefinitionOutWithLinks.md) | [**JsonApiExportDefinitionOutWithLinks**](JsonApiExportDefinitionOutWithLinks.md) | | +[JsonApiUserOutWithLinks](JsonApiUserOutWithLinks.md) | [**JsonApiUserOutWithLinks**](JsonApiUserOutWithLinks.md) | [**JsonApiUserOutWithLinks**](JsonApiUserOutWithLinks.md) | | +[JsonApiAutomationResultOutWithLinks](JsonApiAutomationResultOutWithLinks.md) | [**JsonApiAutomationResultOutWithLinks**](JsonApiAutomationResultOutWithLinks.md) | [**JsonApiAutomationResultOutWithLinks**](JsonApiAutomationResultOutWithLinks.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAutomationOutList.md b/gooddata-api-client/docs/models/JsonApiAutomationOutList.md new file mode 100644 index 000000000..27a31f9ab --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAutomationOutList.md @@ -0,0 +1,59 @@ +# gooddata_api_client.model.json_api_automation_out_list.JsonApiAutomationOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**[included](#included)** | list, tuple, | tuple, | Included resources | [optional] +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiAutomationOutWithLinks**](JsonApiAutomationOutWithLinks.md) | [**JsonApiAutomationOutWithLinks**](JsonApiAutomationOutWithLinks.md) | [**JsonApiAutomationOutWithLinks**](JsonApiAutomationOutWithLinks.md) | | + +# included + +Included resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included resources | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiAutomationOutIncludes**](JsonApiAutomationOutIncludes.md) | [**JsonApiAutomationOutIncludes**](JsonApiAutomationOutIncludes.md) | [**JsonApiAutomationOutIncludes**](JsonApiAutomationOutIncludes.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAutomationOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiAutomationOutWithLinks.md new file mode 100644 index 000000000..c68c699ea --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAutomationOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_automation_out_with_links.JsonApiAutomationOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiAutomationOut](JsonApiAutomationOut.md) | [**JsonApiAutomationOut**](JsonApiAutomationOut.md) | [**JsonApiAutomationOut**](JsonApiAutomationOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAutomationPatch.md b/gooddata-api-client/docs/models/JsonApiAutomationPatch.md new file mode 100644 index 000000000..89888c212 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAutomationPatch.md @@ -0,0 +1,375 @@ +# gooddata_api_client.model.json_api_automation_patch.JsonApiAutomationPatch + +JSON:API representation of patching automation entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching automation entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["automation", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[alert](#alert)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**areRelationsValid** | bool, | BoolClass, | | [optional] +**[dashboardTabularExports](#dashboardTabularExports)** | list, tuple, | tuple, | | [optional] +**description** | str, | str, | | [optional] +**[details](#details)** | dict, frozendict.frozendict, | frozendict.frozendict, | Additional details to be included in the automated message. | [optional] +**evaluationMode** | str, | str, | Specify automation evaluation mode. | [optional] must be one of ["SHARED", "PER_RECIPIENT", ] +**[externalRecipients](#externalRecipients)** | list, tuple, | tuple, | External recipients of the automation action results. | [optional] +**[imageExports](#imageExports)** | list, tuple, | tuple, | | [optional] +**[metadata](#metadata)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Additional information for the automation. | [optional] +**[rawExports](#rawExports)** | list, tuple, | tuple, | | [optional] +**[schedule](#schedule)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[slidesExports](#slidesExports)** | list, tuple, | tuple, | | [optional] +**state** | str, | str, | Current state of the automation. | [optional] must be one of ["ACTIVE", "PAUSED", ] +**[tabularExports](#tabularExports)** | list, tuple, | tuple, | | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**[visualExports](#visualExports)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# alert + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**execution** | [**AlertAfm**](AlertAfm.md) | [**AlertAfm**](AlertAfm.md) | | +**condition** | [**AlertCondition**](AlertCondition.md) | [**AlertCondition**](AlertCondition.md) | | +**interval** | str, | str, | Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR. | [optional] must be one of ["DAY", "WEEK", "MONTH", "QUARTER", "YEAR", ] +**trigger** | str, | 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] must be one of ["ALWAYS", "ONCE", "ONCE_PER_INTERVAL", ] if omitted the server will use the default value of "ALWAYS" +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dashboardTabularExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**DashboardTabularExportRequestV2**](DashboardTabularExportRequestV2.md) | [**DashboardTabularExportRequestV2**](DashboardTabularExportRequestV2.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# details + +Additional details to be included in the automated message. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Additional details to be included in the automated message. | + +# externalRecipients + +External recipients of the automation action results. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | External recipients of the automation action results. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**email** | str, | str, | E-mail address to send notifications from. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# imageExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**ImageExportRequest**](ImageExportRequest.md) | [**ImageExportRequest**](ImageExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# metadata + +Additional information for the automation. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Additional information for the automation. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[visibleFilters](#visibleFilters)** | list, tuple, | tuple, | | [optional] +**widget** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# visibleFilters + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**VisibleFilter**](VisibleFilter.md) | [**VisibleFilter**](VisibleFilter.md) | [**VisibleFilter**](VisibleFilter.md) | | + +# rawExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**RawExportAutomationRequest**](RawExportAutomationRequest.md) | [**RawExportAutomationRequest**](RawExportAutomationRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# schedule + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**cron** | str, | str, | 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. | +**timezone** | str, | str, | Timezone in which the schedule is defined. | +**cronDescription** | str, | str, | Human-readable description of the cron expression. | [optional] +**firstRun** | str, datetime, | str, | Timestamp of the first scheduled action. If not provided default to the next scheduled time. | [optional] value must conform to RFC-3339 date-time +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# slidesExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**SlidesExportRequest**](SlidesExportRequest.md) | [**SlidesExportRequest**](SlidesExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tabularExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**TabularExportRequest**](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# visualExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**VisualExportRequest**](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[analyticalDashboard](#analyticalDashboard)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[exportDefinitions](#exportDefinitions)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[notificationChannel](#notificationChannel)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[recipients](#recipients)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# analyticalDashboard + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# exportDefinitions + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiExportDefinitionToManyLinkage**](JsonApiExportDefinitionToManyLinkage.md) | [**JsonApiExportDefinitionToManyLinkage**](JsonApiExportDefinitionToManyLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# notificationChannel + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiNotificationChannelToOneLinkage**](JsonApiNotificationChannelToOneLinkage.md) | [**JsonApiNotificationChannelToOneLinkage**](JsonApiNotificationChannelToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# recipients + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserToManyLinkage**](JsonApiUserToManyLinkage.md) | [**JsonApiUserToManyLinkage**](JsonApiUserToManyLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAutomationPatchDocument.md b/gooddata-api-client/docs/models/JsonApiAutomationPatchDocument.md new file mode 100644 index 000000000..51fd49de2 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAutomationPatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_automation_patch_document.JsonApiAutomationPatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAutomationPatch**](JsonApiAutomationPatch.md) | [**JsonApiAutomationPatch**](JsonApiAutomationPatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAutomationResultLinkage.md b/gooddata-api-client/docs/models/JsonApiAutomationResultLinkage.md new file mode 100644 index 000000000..a3fd82006 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAutomationResultLinkage.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.json_api_automation_result_linkage.JsonApiAutomationResultLinkage + +The \\\"type\\\" and \\\"id\\\" to non-empty members. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | The \\\"type\\\" and \\\"id\\\" to non-empty members. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**type** | str, | str, | | must be one of ["automationResult", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAutomationResultOut.md b/gooddata-api-client/docs/models/JsonApiAutomationResultOut.md new file mode 100644 index 000000000..6877c7ebc --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAutomationResultOut.md @@ -0,0 +1,62 @@ +# gooddata_api_client.model.json_api_automation_result_out.JsonApiAutomationResultOut + +JSON:API representation of automationResult entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of automationResult entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["automationResult", ] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**executedAt** | str, datetime, | str, | Timestamp of the last automation run. | value must conform to RFC-3339 date-time +**status** | str, | str, | Status of the last automation run. | must be one of ["SUCCESS", "FAILED", ] +**errorMessage** | str, | str, | | [optional] +**traceId** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[automation](#automation)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# automation + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAutomationToOneLinkage**](JsonApiAutomationToOneLinkage.md) | [**JsonApiAutomationToOneLinkage**](JsonApiAutomationToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAutomationResultOutList.md b/gooddata-api-client/docs/models/JsonApiAutomationResultOutList.md new file mode 100644 index 000000000..7716c9f40 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAutomationResultOutList.md @@ -0,0 +1,59 @@ +# gooddata_api_client.model.json_api_automation_result_out_list.JsonApiAutomationResultOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**[included](#included)** | list, tuple, | tuple, | Included resources | [optional] +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiAutomationResultOutWithLinks**](JsonApiAutomationResultOutWithLinks.md) | [**JsonApiAutomationResultOutWithLinks**](JsonApiAutomationResultOutWithLinks.md) | [**JsonApiAutomationResultOutWithLinks**](JsonApiAutomationResultOutWithLinks.md) | | + +# included + +Included resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included resources | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiAutomationOutWithLinks**](JsonApiAutomationOutWithLinks.md) | [**JsonApiAutomationOutWithLinks**](JsonApiAutomationOutWithLinks.md) | [**JsonApiAutomationOutWithLinks**](JsonApiAutomationOutWithLinks.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAutomationResultOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiAutomationResultOutWithLinks.md new file mode 100644 index 000000000..903b21cbb --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAutomationResultOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_automation_result_out_with_links.JsonApiAutomationResultOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiAutomationResultOut](JsonApiAutomationResultOut.md) | [**JsonApiAutomationResultOut**](JsonApiAutomationResultOut.md) | [**JsonApiAutomationResultOut**](JsonApiAutomationResultOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAutomationResultToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiAutomationResultToManyLinkage.md new file mode 100644 index 000000000..c8b5885e3 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAutomationResultToManyLinkage.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_automation_result_to_many_linkage.JsonApiAutomationResultToManyLinkage + +References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiAutomationResultLinkage**](JsonApiAutomationResultLinkage.md) | [**JsonApiAutomationResultLinkage**](JsonApiAutomationResultLinkage.md) | [**JsonApiAutomationResultLinkage**](JsonApiAutomationResultLinkage.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiAutomationToOneLinkage.md b/gooddata-api-client/docs/models/JsonApiAutomationToOneLinkage.md new file mode 100644 index 000000000..050f61acd --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiAutomationToOneLinkage.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.json_api_automation_to_one_linkage.JsonApiAutomationToOneLinkage + +References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiAutomationLinkage](JsonApiAutomationLinkage.md) | [**JsonApiAutomationLinkage**](JsonApiAutomationLinkage.md) | [**JsonApiAutomationLinkage**](JsonApiAutomationLinkage.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionIn.md b/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionIn.md new file mode 100644 index 000000000..f07ba4037 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionIn.md @@ -0,0 +1,33 @@ +# gooddata_api_client.model.json_api_custom_geo_collection_in.JsonApiCustomGeoCollectionIn + +JSON:API representation of customGeoCollection entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of customGeoCollection entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["customGeoCollection", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**description** | None, str, | NoneClass, str, | | [optional] +**name** | None, str, | NoneClass, str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionInDocument.md b/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionInDocument.md new file mode 100644 index 000000000..a083520e5 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionInDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_custom_geo_collection_in_document.JsonApiCustomGeoCollectionInDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiCustomGeoCollectionIn**](JsonApiCustomGeoCollectionIn.md) | [**JsonApiCustomGeoCollectionIn**](JsonApiCustomGeoCollectionIn.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionOut.md b/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionOut.md new file mode 100644 index 000000000..953f3d22f --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionOut.md @@ -0,0 +1,33 @@ +# gooddata_api_client.model.json_api_custom_geo_collection_out.JsonApiCustomGeoCollectionOut + +JSON:API representation of customGeoCollection entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of customGeoCollection entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["customGeoCollection", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**description** | None, str, | NoneClass, str, | | [optional] +**name** | None, str, | NoneClass, str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionOutDocument.md b/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionOutDocument.md new file mode 100644 index 000000000..c3ca72ad6 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionOutDocument.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_custom_geo_collection_out_document.JsonApiCustomGeoCollectionOutDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiCustomGeoCollectionOut**](JsonApiCustomGeoCollectionOut.md) | [**JsonApiCustomGeoCollectionOut**](JsonApiCustomGeoCollectionOut.md) | | +**links** | [**ObjectLinks**](ObjectLinks.md) | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionOutList.md b/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionOutList.md new file mode 100644 index 000000000..acd64c81e --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionOutList.md @@ -0,0 +1,44 @@ +# gooddata_api_client.model.json_api_custom_geo_collection_out_list.JsonApiCustomGeoCollectionOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiCustomGeoCollectionOutWithLinks**](JsonApiCustomGeoCollectionOutWithLinks.md) | [**JsonApiCustomGeoCollectionOutWithLinks**](JsonApiCustomGeoCollectionOutWithLinks.md) | [**JsonApiCustomGeoCollectionOutWithLinks**](JsonApiCustomGeoCollectionOutWithLinks.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionOutWithLinks.md new file mode 100644 index 000000000..10f8277f6 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_custom_geo_collection_out_with_links.JsonApiCustomGeoCollectionOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiCustomGeoCollectionOut](JsonApiCustomGeoCollectionOut.md) | [**JsonApiCustomGeoCollectionOut**](JsonApiCustomGeoCollectionOut.md) | [**JsonApiCustomGeoCollectionOut**](JsonApiCustomGeoCollectionOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionPatch.md b/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionPatch.md new file mode 100644 index 000000000..dfcf9a259 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionPatch.md @@ -0,0 +1,33 @@ +# gooddata_api_client.model.json_api_custom_geo_collection_patch.JsonApiCustomGeoCollectionPatch + +JSON:API representation of patching customGeoCollection entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching customGeoCollection entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["customGeoCollection", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**description** | None, str, | NoneClass, str, | | [optional] +**name** | None, str, | NoneClass, str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionPatchDocument.md b/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionPatchDocument.md new file mode 100644 index 000000000..c80453bc1 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiCustomGeoCollectionPatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_custom_geo_collection_patch_document.JsonApiCustomGeoCollectionPatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiCustomGeoCollectionPatch**](JsonApiCustomGeoCollectionPatch.md) | [**JsonApiCustomGeoCollectionPatch**](JsonApiCustomGeoCollectionPatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiDatasetPatch.md b/gooddata-api-client/docs/models/JsonApiDatasetPatch.md new file mode 100644 index 000000000..27648b5d5 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiDatasetPatch.md @@ -0,0 +1,46 @@ +# gooddata_api_client.model.json_api_dataset_patch.JsonApiDatasetPatch + +JSON:API representation of patching dataset entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching dataset entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["dataset", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**description** | str, | str, | | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiDatasetPatchDocument.md b/gooddata-api-client/docs/models/JsonApiDatasetPatchDocument.md new file mode 100644 index 000000000..d25836a33 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiDatasetPatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_dataset_patch_document.JsonApiDatasetPatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiDatasetPatch**](JsonApiDatasetPatch.md) | [**JsonApiDatasetPatch**](JsonApiDatasetPatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportDefinitionIn.md b/gooddata-api-client/docs/models/JsonApiExportDefinitionIn.md new file mode 100644 index 000000000..6dd31efb3 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportDefinitionIn.md @@ -0,0 +1,105 @@ +# gooddata_api_client.model.json_api_export_definition_in.JsonApiExportDefinitionIn + +JSON:API representation of exportDefinition entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of exportDefinition entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["exportDefinition", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**areRelationsValid** | bool, | BoolClass, | | [optional] +**description** | str, | str, | | [optional] +**[requestPayload](#requestPayload)** | dict, frozendict.frozendict, | frozendict.frozendict, | JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# requestPayload + +JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[VisualExportRequest](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | | +[TabularExportRequest](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[analyticalDashboard](#analyticalDashboard)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[visualizationObject](#visualizationObject)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# analyticalDashboard + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# visualizationObject + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiVisualizationObjectToOneLinkage**](JsonApiVisualizationObjectToOneLinkage.md) | [**JsonApiVisualizationObjectToOneLinkage**](JsonApiVisualizationObjectToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportDefinitionInDocument.md b/gooddata-api-client/docs/models/JsonApiExportDefinitionInDocument.md new file mode 100644 index 000000000..859f75179 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportDefinitionInDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_export_definition_in_document.JsonApiExportDefinitionInDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiExportDefinitionIn**](JsonApiExportDefinitionIn.md) | [**JsonApiExportDefinitionIn**](JsonApiExportDefinitionIn.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportDefinitionLinkage.md b/gooddata-api-client/docs/models/JsonApiExportDefinitionLinkage.md new file mode 100644 index 000000000..53ee8ec57 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportDefinitionLinkage.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.json_api_export_definition_linkage.JsonApiExportDefinitionLinkage + +The \\\"type\\\" and \\\"id\\\" to non-empty members. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | The \\\"type\\\" and \\\"id\\\" to non-empty members. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**type** | str, | str, | | must be one of ["exportDefinition", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportDefinitionOut.md b/gooddata-api-client/docs/models/JsonApiExportDefinitionOut.md new file mode 100644 index 000000000..008fee779 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportDefinitionOut.md @@ -0,0 +1,177 @@ +# gooddata_api_client.model.json_api_export_definition_out.JsonApiExportDefinitionOut + +JSON:API representation of exportDefinition entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of exportDefinition entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["exportDefinition", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**areRelationsValid** | bool, | BoolClass, | | [optional] +**createdAt** | None, str, datetime, | NoneClass, str, | Time of the entity creation. | [optional] value must conform to RFC-3339 date-time +**description** | str, | str, | | [optional] +**modifiedAt** | None, str, datetime, | NoneClass, str, | Time of the last entity modification. | [optional] value must conform to RFC-3339 date-time +**[requestPayload](#requestPayload)** | dict, frozendict.frozendict, | frozendict.frozendict, | JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# requestPayload + +JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[VisualExportRequest](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | | +[TabularExportRequest](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[origin](#origin)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# origin + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**originType** | str, | str, | defines type of the origin of the entity | must be one of ["NATIVE", "PARENT", ] +**originId** | str, | str, | defines id of the workspace where the entity comes from | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[analyticalDashboard](#analyticalDashboard)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[automation](#automation)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[createdBy](#createdBy)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[modifiedBy](#modifiedBy)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[visualizationObject](#visualizationObject)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# analyticalDashboard + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# automation + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAutomationToOneLinkage**](JsonApiAutomationToOneLinkage.md) | [**JsonApiAutomationToOneLinkage**](JsonApiAutomationToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# createdBy + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# modifiedBy + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# visualizationObject + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiVisualizationObjectToOneLinkage**](JsonApiVisualizationObjectToOneLinkage.md) | [**JsonApiVisualizationObjectToOneLinkage**](JsonApiVisualizationObjectToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportDefinitionOutDocument.md b/gooddata-api-client/docs/models/JsonApiExportDefinitionOutDocument.md new file mode 100644 index 000000000..9c27c92c2 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportDefinitionOutDocument.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.json_api_export_definition_out_document.JsonApiExportDefinitionOutDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiExportDefinitionOut**](JsonApiExportDefinitionOut.md) | [**JsonApiExportDefinitionOut**](JsonApiExportDefinitionOut.md) | | +**[included](#included)** | list, tuple, | tuple, | Included resources | [optional] +**links** | [**ObjectLinks**](ObjectLinks.md) | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# included + +Included resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included resources | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiExportDefinitionOutIncludes**](JsonApiExportDefinitionOutIncludes.md) | [**JsonApiExportDefinitionOutIncludes**](JsonApiExportDefinitionOutIncludes.md) | [**JsonApiExportDefinitionOutIncludes**](JsonApiExportDefinitionOutIncludes.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportDefinitionOutIncludes.md b/gooddata-api-client/docs/models/JsonApiExportDefinitionOutIncludes.md new file mode 100644 index 000000000..992440f82 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportDefinitionOutIncludes.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.json_api_export_definition_out_includes.JsonApiExportDefinitionOutIncludes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiVisualizationObjectOutWithLinks](JsonApiVisualizationObjectOutWithLinks.md) | [**JsonApiVisualizationObjectOutWithLinks**](JsonApiVisualizationObjectOutWithLinks.md) | [**JsonApiVisualizationObjectOutWithLinks**](JsonApiVisualizationObjectOutWithLinks.md) | | +[JsonApiAnalyticalDashboardOutWithLinks](JsonApiAnalyticalDashboardOutWithLinks.md) | [**JsonApiAnalyticalDashboardOutWithLinks**](JsonApiAnalyticalDashboardOutWithLinks.md) | [**JsonApiAnalyticalDashboardOutWithLinks**](JsonApiAnalyticalDashboardOutWithLinks.md) | | +[JsonApiAutomationOutWithLinks](JsonApiAutomationOutWithLinks.md) | [**JsonApiAutomationOutWithLinks**](JsonApiAutomationOutWithLinks.md) | [**JsonApiAutomationOutWithLinks**](JsonApiAutomationOutWithLinks.md) | | +[JsonApiUserIdentifierOutWithLinks](JsonApiUserIdentifierOutWithLinks.md) | [**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | [**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportDefinitionOutList.md b/gooddata-api-client/docs/models/JsonApiExportDefinitionOutList.md new file mode 100644 index 000000000..76e0678ef --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportDefinitionOutList.md @@ -0,0 +1,59 @@ +# gooddata_api_client.model.json_api_export_definition_out_list.JsonApiExportDefinitionOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**[included](#included)** | list, tuple, | tuple, | Included resources | [optional] +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiExportDefinitionOutWithLinks**](JsonApiExportDefinitionOutWithLinks.md) | [**JsonApiExportDefinitionOutWithLinks**](JsonApiExportDefinitionOutWithLinks.md) | [**JsonApiExportDefinitionOutWithLinks**](JsonApiExportDefinitionOutWithLinks.md) | | + +# included + +Included resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included resources | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiExportDefinitionOutIncludes**](JsonApiExportDefinitionOutIncludes.md) | [**JsonApiExportDefinitionOutIncludes**](JsonApiExportDefinitionOutIncludes.md) | [**JsonApiExportDefinitionOutIncludes**](JsonApiExportDefinitionOutIncludes.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportDefinitionOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiExportDefinitionOutWithLinks.md new file mode 100644 index 000000000..2f52324e1 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportDefinitionOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_export_definition_out_with_links.JsonApiExportDefinitionOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiExportDefinitionOut](JsonApiExportDefinitionOut.md) | [**JsonApiExportDefinitionOut**](JsonApiExportDefinitionOut.md) | [**JsonApiExportDefinitionOut**](JsonApiExportDefinitionOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportDefinitionPatch.md b/gooddata-api-client/docs/models/JsonApiExportDefinitionPatch.md new file mode 100644 index 000000000..9afc38993 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportDefinitionPatch.md @@ -0,0 +1,105 @@ +# gooddata_api_client.model.json_api_export_definition_patch.JsonApiExportDefinitionPatch + +JSON:API representation of patching exportDefinition entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching exportDefinition entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["exportDefinition", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**areRelationsValid** | bool, | BoolClass, | | [optional] +**description** | str, | str, | | [optional] +**[requestPayload](#requestPayload)** | dict, frozendict.frozendict, | frozendict.frozendict, | JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# requestPayload + +JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[VisualExportRequest](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | | +[TabularExportRequest](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[analyticalDashboard](#analyticalDashboard)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[visualizationObject](#visualizationObject)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# analyticalDashboard + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# visualizationObject + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiVisualizationObjectToOneLinkage**](JsonApiVisualizationObjectToOneLinkage.md) | [**JsonApiVisualizationObjectToOneLinkage**](JsonApiVisualizationObjectToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportDefinitionPatchDocument.md b/gooddata-api-client/docs/models/JsonApiExportDefinitionPatchDocument.md new file mode 100644 index 000000000..264aa83b8 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportDefinitionPatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_export_definition_patch_document.JsonApiExportDefinitionPatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiExportDefinitionPatch**](JsonApiExportDefinitionPatch.md) | [**JsonApiExportDefinitionPatch**](JsonApiExportDefinitionPatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportDefinitionPostOptionalId.md b/gooddata-api-client/docs/models/JsonApiExportDefinitionPostOptionalId.md new file mode 100644 index 000000000..271b502aa --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportDefinitionPostOptionalId.md @@ -0,0 +1,105 @@ +# gooddata_api_client.model.json_api_export_definition_post_optional_id.JsonApiExportDefinitionPostOptionalId + +JSON:API representation of exportDefinition entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of exportDefinition entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**type** | str, | str, | Object type | must be one of ["exportDefinition", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**id** | str, | str, | API identifier of an object | [optional] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**areRelationsValid** | bool, | BoolClass, | | [optional] +**description** | str, | str, | | [optional] +**[requestPayload](#requestPayload)** | dict, frozendict.frozendict, | frozendict.frozendict, | JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# requestPayload + +JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[VisualExportRequest](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | | +[TabularExportRequest](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[analyticalDashboard](#analyticalDashboard)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[visualizationObject](#visualizationObject)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# analyticalDashboard + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# visualizationObject + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiVisualizationObjectToOneLinkage**](JsonApiVisualizationObjectToOneLinkage.md) | [**JsonApiVisualizationObjectToOneLinkage**](JsonApiVisualizationObjectToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportDefinitionPostOptionalIdDocument.md b/gooddata-api-client/docs/models/JsonApiExportDefinitionPostOptionalIdDocument.md new file mode 100644 index 000000000..921b2d927 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportDefinitionPostOptionalIdDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_export_definition_post_optional_id_document.JsonApiExportDefinitionPostOptionalIdDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiExportDefinitionPostOptionalId**](JsonApiExportDefinitionPostOptionalId.md) | [**JsonApiExportDefinitionPostOptionalId**](JsonApiExportDefinitionPostOptionalId.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportDefinitionToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiExportDefinitionToManyLinkage.md new file mode 100644 index 000000000..a100c02c2 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportDefinitionToManyLinkage.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_export_definition_to_many_linkage.JsonApiExportDefinitionToManyLinkage + +References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiExportDefinitionLinkage**](JsonApiExportDefinitionLinkage.md) | [**JsonApiExportDefinitionLinkage**](JsonApiExportDefinitionLinkage.md) | [**JsonApiExportDefinitionLinkage**](JsonApiExportDefinitionLinkage.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportTemplateIn.md b/gooddata-api-client/docs/models/JsonApiExportTemplateIn.md new file mode 100644 index 000000000..436e9d98e --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportTemplateIn.md @@ -0,0 +1,97 @@ +# gooddata_api_client.model.json_api_export_template_in.JsonApiExportTemplateIn + +JSON:API representation of exportTemplate entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of exportTemplate entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["exportTemplate", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**name** | str, | str, | User-facing name of the Slides template. | +**[dashboardSlidesTemplate](#dashboardSlidesTemplate)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | [optional] +**[widgetSlidesTemplate](#widgetSlidesTemplate)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dashboardSlidesTemplate + +Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[appliedOn](#appliedOn)** | list, tuple, | tuple, | Export types this template applies to. | +**contentSlide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] +**coverSlide** | [**CoverSlideTemplate**](CoverSlideTemplate.md) | [**CoverSlideTemplate**](CoverSlideTemplate.md) | | [optional] +**introSlide** | [**IntroSlideTemplate**](IntroSlideTemplate.md) | [**IntroSlideTemplate**](IntroSlideTemplate.md) | | [optional] +**sectionSlide** | [**SectionSlideTemplate**](SectionSlideTemplate.md) | [**SectionSlideTemplate**](SectionSlideTemplate.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# appliedOn + +Export types this template applies to. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Export types this template applies to. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["PDF", "PPTX", ] + +# widgetSlidesTemplate + +Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[appliedOn](#appliedOn)** | list, tuple, | tuple, | Export types this template applies to. | +**contentSlide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# appliedOn + +Export types this template applies to. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Export types this template applies to. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["PDF", "PPTX", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportTemplateInDocument.md b/gooddata-api-client/docs/models/JsonApiExportTemplateInDocument.md new file mode 100644 index 000000000..aed56b929 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportTemplateInDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_export_template_in_document.JsonApiExportTemplateInDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiExportTemplateIn**](JsonApiExportTemplateIn.md) | [**JsonApiExportTemplateIn**](JsonApiExportTemplateIn.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportTemplateOut.md b/gooddata-api-client/docs/models/JsonApiExportTemplateOut.md new file mode 100644 index 000000000..25a5cec53 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportTemplateOut.md @@ -0,0 +1,97 @@ +# gooddata_api_client.model.json_api_export_template_out.JsonApiExportTemplateOut + +JSON:API representation of exportTemplate entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of exportTemplate entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["exportTemplate", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**name** | str, | str, | User-facing name of the Slides template. | +**[dashboardSlidesTemplate](#dashboardSlidesTemplate)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | [optional] +**[widgetSlidesTemplate](#widgetSlidesTemplate)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dashboardSlidesTemplate + +Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[appliedOn](#appliedOn)** | list, tuple, | tuple, | Export types this template applies to. | +**contentSlide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] +**coverSlide** | [**CoverSlideTemplate**](CoverSlideTemplate.md) | [**CoverSlideTemplate**](CoverSlideTemplate.md) | | [optional] +**introSlide** | [**IntroSlideTemplate**](IntroSlideTemplate.md) | [**IntroSlideTemplate**](IntroSlideTemplate.md) | | [optional] +**sectionSlide** | [**SectionSlideTemplate**](SectionSlideTemplate.md) | [**SectionSlideTemplate**](SectionSlideTemplate.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# appliedOn + +Export types this template applies to. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Export types this template applies to. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["PDF", "PPTX", ] + +# widgetSlidesTemplate + +Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[appliedOn](#appliedOn)** | list, tuple, | tuple, | Export types this template applies to. | +**contentSlide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# appliedOn + +Export types this template applies to. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Export types this template applies to. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["PDF", "PPTX", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportTemplateOutDocument.md b/gooddata-api-client/docs/models/JsonApiExportTemplateOutDocument.md new file mode 100644 index 000000000..b897c8814 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportTemplateOutDocument.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_export_template_out_document.JsonApiExportTemplateOutDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiExportTemplateOut**](JsonApiExportTemplateOut.md) | [**JsonApiExportTemplateOut**](JsonApiExportTemplateOut.md) | | +**links** | [**ObjectLinks**](ObjectLinks.md) | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportTemplateOutList.md b/gooddata-api-client/docs/models/JsonApiExportTemplateOutList.md new file mode 100644 index 000000000..f18e01e9e --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportTemplateOutList.md @@ -0,0 +1,44 @@ +# gooddata_api_client.model.json_api_export_template_out_list.JsonApiExportTemplateOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiExportTemplateOutWithLinks**](JsonApiExportTemplateOutWithLinks.md) | [**JsonApiExportTemplateOutWithLinks**](JsonApiExportTemplateOutWithLinks.md) | [**JsonApiExportTemplateOutWithLinks**](JsonApiExportTemplateOutWithLinks.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportTemplateOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiExportTemplateOutWithLinks.md new file mode 100644 index 000000000..9112feaad --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportTemplateOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_export_template_out_with_links.JsonApiExportTemplateOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiExportTemplateOut](JsonApiExportTemplateOut.md) | [**JsonApiExportTemplateOut**](JsonApiExportTemplateOut.md) | [**JsonApiExportTemplateOut**](JsonApiExportTemplateOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportTemplatePatch.md b/gooddata-api-client/docs/models/JsonApiExportTemplatePatch.md new file mode 100644 index 000000000..57096bc5f --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportTemplatePatch.md @@ -0,0 +1,97 @@ +# gooddata_api_client.model.json_api_export_template_patch.JsonApiExportTemplatePatch + +JSON:API representation of patching exportTemplate entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching exportTemplate entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["exportTemplate", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[dashboardSlidesTemplate](#dashboardSlidesTemplate)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | [optional] +**name** | str, | str, | User-facing name of the Slides template. | [optional] +**[widgetSlidesTemplate](#widgetSlidesTemplate)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dashboardSlidesTemplate + +Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[appliedOn](#appliedOn)** | list, tuple, | tuple, | Export types this template applies to. | +**contentSlide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] +**coverSlide** | [**CoverSlideTemplate**](CoverSlideTemplate.md) | [**CoverSlideTemplate**](CoverSlideTemplate.md) | | [optional] +**introSlide** | [**IntroSlideTemplate**](IntroSlideTemplate.md) | [**IntroSlideTemplate**](IntroSlideTemplate.md) | | [optional] +**sectionSlide** | [**SectionSlideTemplate**](SectionSlideTemplate.md) | [**SectionSlideTemplate**](SectionSlideTemplate.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# appliedOn + +Export types this template applies to. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Export types this template applies to. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["PDF", "PPTX", ] + +# widgetSlidesTemplate + +Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[appliedOn](#appliedOn)** | list, tuple, | tuple, | Export types this template applies to. | +**contentSlide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# appliedOn + +Export types this template applies to. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Export types this template applies to. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["PDF", "PPTX", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportTemplatePatchDocument.md b/gooddata-api-client/docs/models/JsonApiExportTemplatePatchDocument.md new file mode 100644 index 000000000..e541318a8 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportTemplatePatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_export_template_patch_document.JsonApiExportTemplatePatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiExportTemplatePatch**](JsonApiExportTemplatePatch.md) | [**JsonApiExportTemplatePatch**](JsonApiExportTemplatePatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportTemplatePostOptionalId.md b/gooddata-api-client/docs/models/JsonApiExportTemplatePostOptionalId.md new file mode 100644 index 000000000..6568f31da --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportTemplatePostOptionalId.md @@ -0,0 +1,97 @@ +# gooddata_api_client.model.json_api_export_template_post_optional_id.JsonApiExportTemplatePostOptionalId + +JSON:API representation of exportTemplate entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of exportTemplate entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**type** | str, | str, | Object type | must be one of ["exportTemplate", ] +**id** | str, | str, | API identifier of an object | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**name** | str, | str, | User-facing name of the Slides template. | +**[dashboardSlidesTemplate](#dashboardSlidesTemplate)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | [optional] +**[widgetSlidesTemplate](#widgetSlidesTemplate)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dashboardSlidesTemplate + +Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[appliedOn](#appliedOn)** | list, tuple, | tuple, | Export types this template applies to. | +**contentSlide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] +**coverSlide** | [**CoverSlideTemplate**](CoverSlideTemplate.md) | [**CoverSlideTemplate**](CoverSlideTemplate.md) | | [optional] +**introSlide** | [**IntroSlideTemplate**](IntroSlideTemplate.md) | [**IntroSlideTemplate**](IntroSlideTemplate.md) | | [optional] +**sectionSlide** | [**SectionSlideTemplate**](SectionSlideTemplate.md) | [**SectionSlideTemplate**](SectionSlideTemplate.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# appliedOn + +Export types this template applies to. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Export types this template applies to. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["PDF", "PPTX", ] + +# widgetSlidesTemplate + +Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[appliedOn](#appliedOn)** | list, tuple, | tuple, | Export types this template applies to. | +**contentSlide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# appliedOn + +Export types this template applies to. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Export types this template applies to. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["PDF", "PPTX", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiExportTemplatePostOptionalIdDocument.md b/gooddata-api-client/docs/models/JsonApiExportTemplatePostOptionalIdDocument.md new file mode 100644 index 000000000..3411eaf04 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiExportTemplatePostOptionalIdDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_export_template_post_optional_id_document.JsonApiExportTemplatePostOptionalIdDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiExportTemplatePostOptionalId**](JsonApiExportTemplatePostOptionalId.md) | [**JsonApiExportTemplatePostOptionalId**](JsonApiExportTemplatePostOptionalId.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiFactPatch.md b/gooddata-api-client/docs/models/JsonApiFactPatch.md new file mode 100644 index 000000000..6b8f0d44b --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiFactPatch.md @@ -0,0 +1,46 @@ +# gooddata_api_client.model.json_api_fact_patch.JsonApiFactPatch + +JSON:API representation of patching fact entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching fact entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["fact", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**description** | str, | str, | | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiFactPatchDocument.md b/gooddata-api-client/docs/models/JsonApiFactPatchDocument.md new file mode 100644 index 000000000..0f809ea10 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiFactPatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_fact_patch_document.JsonApiFactPatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiFactPatch**](JsonApiFactPatch.md) | [**JsonApiFactPatch**](JsonApiFactPatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiFactToOneLinkage.md b/gooddata-api-client/docs/models/JsonApiFactToOneLinkage.md new file mode 100644 index 000000000..80d0fb249 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiFactToOneLinkage.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.json_api_fact_to_one_linkage.JsonApiFactToOneLinkage + +References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiFactLinkage](JsonApiFactLinkage.md) | [**JsonApiFactLinkage**](JsonApiFactLinkage.md) | [**JsonApiFactLinkage**](JsonApiFactLinkage.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiFilterViewIn.md b/gooddata-api-client/docs/models/JsonApiFilterViewIn.md new file mode 100644 index 000000000..d0b005bc8 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiFilterViewIn.md @@ -0,0 +1,99 @@ +# gooddata_api_client.model.json_api_filter_view_in.JsonApiFilterViewIn + +JSON:API representation of filterView entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of filterView entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["filterView", ] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**title** | str, | str, | | +**[content](#content)** | dict, frozendict.frozendict, | frozendict.frozendict, | The respective filter context. | +**areRelationsValid** | bool, | BoolClass, | | [optional] +**description** | str, | str, | | [optional] +**isDefault** | bool, | BoolClass, | Indicator whether the filter view should by applied by default. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# content + +The respective filter context. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | The respective filter context. | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[analyticalDashboard](#analyticalDashboard)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[user](#user)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# analyticalDashboard + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# user + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserToOneLinkage**](JsonApiUserToOneLinkage.md) | [**JsonApiUserToOneLinkage**](JsonApiUserToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiFilterViewInDocument.md b/gooddata-api-client/docs/models/JsonApiFilterViewInDocument.md new file mode 100644 index 000000000..3befb36ae --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiFilterViewInDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_filter_view_in_document.JsonApiFilterViewInDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiFilterViewIn**](JsonApiFilterViewIn.md) | [**JsonApiFilterViewIn**](JsonApiFilterViewIn.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiFilterViewOut.md b/gooddata-api-client/docs/models/JsonApiFilterViewOut.md new file mode 100644 index 000000000..b3db31f73 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiFilterViewOut.md @@ -0,0 +1,99 @@ +# gooddata_api_client.model.json_api_filter_view_out.JsonApiFilterViewOut + +JSON:API representation of filterView entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of filterView entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["filterView", ] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**title** | str, | str, | | +**[content](#content)** | dict, frozendict.frozendict, | frozendict.frozendict, | The respective filter context. | +**areRelationsValid** | bool, | BoolClass, | | [optional] +**description** | str, | str, | | [optional] +**isDefault** | bool, | BoolClass, | Indicator whether the filter view should by applied by default. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# content + +The respective filter context. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | The respective filter context. | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[analyticalDashboard](#analyticalDashboard)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[user](#user)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# analyticalDashboard + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# user + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserToOneLinkage**](JsonApiUserToOneLinkage.md) | [**JsonApiUserToOneLinkage**](JsonApiUserToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiFilterViewOutDocument.md b/gooddata-api-client/docs/models/JsonApiFilterViewOutDocument.md new file mode 100644 index 000000000..26dc27cdd --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiFilterViewOutDocument.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.json_api_filter_view_out_document.JsonApiFilterViewOutDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiFilterViewOut**](JsonApiFilterViewOut.md) | [**JsonApiFilterViewOut**](JsonApiFilterViewOut.md) | | +**[included](#included)** | list, tuple, | tuple, | Included resources | [optional] +**links** | [**ObjectLinks**](ObjectLinks.md) | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# included + +Included resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included resources | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiFilterViewOutIncludes**](JsonApiFilterViewOutIncludes.md) | [**JsonApiFilterViewOutIncludes**](JsonApiFilterViewOutIncludes.md) | [**JsonApiFilterViewOutIncludes**](JsonApiFilterViewOutIncludes.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiFilterViewOutIncludes.md b/gooddata-api-client/docs/models/JsonApiFilterViewOutIncludes.md new file mode 100644 index 000000000..2d6a04c5b --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiFilterViewOutIncludes.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_filter_view_out_includes.JsonApiFilterViewOutIncludes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiAnalyticalDashboardOutWithLinks](JsonApiAnalyticalDashboardOutWithLinks.md) | [**JsonApiAnalyticalDashboardOutWithLinks**](JsonApiAnalyticalDashboardOutWithLinks.md) | [**JsonApiAnalyticalDashboardOutWithLinks**](JsonApiAnalyticalDashboardOutWithLinks.md) | | +[JsonApiUserOutWithLinks](JsonApiUserOutWithLinks.md) | [**JsonApiUserOutWithLinks**](JsonApiUserOutWithLinks.md) | [**JsonApiUserOutWithLinks**](JsonApiUserOutWithLinks.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiFilterViewOutList.md b/gooddata-api-client/docs/models/JsonApiFilterViewOutList.md new file mode 100644 index 000000000..a67d02d2b --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiFilterViewOutList.md @@ -0,0 +1,59 @@ +# gooddata_api_client.model.json_api_filter_view_out_list.JsonApiFilterViewOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**[included](#included)** | list, tuple, | tuple, | Included resources | [optional] +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiFilterViewOutWithLinks**](JsonApiFilterViewOutWithLinks.md) | [**JsonApiFilterViewOutWithLinks**](JsonApiFilterViewOutWithLinks.md) | [**JsonApiFilterViewOutWithLinks**](JsonApiFilterViewOutWithLinks.md) | | + +# included + +Included resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included resources | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiFilterViewOutIncludes**](JsonApiFilterViewOutIncludes.md) | [**JsonApiFilterViewOutIncludes**](JsonApiFilterViewOutIncludes.md) | [**JsonApiFilterViewOutIncludes**](JsonApiFilterViewOutIncludes.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiFilterViewOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiFilterViewOutWithLinks.md new file mode 100644 index 000000000..acdc795a8 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiFilterViewOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_filter_view_out_with_links.JsonApiFilterViewOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiFilterViewOut](JsonApiFilterViewOut.md) | [**JsonApiFilterViewOut**](JsonApiFilterViewOut.md) | [**JsonApiFilterViewOut**](JsonApiFilterViewOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiFilterViewPatch.md b/gooddata-api-client/docs/models/JsonApiFilterViewPatch.md new file mode 100644 index 000000000..f296ff87b --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiFilterViewPatch.md @@ -0,0 +1,99 @@ +# gooddata_api_client.model.json_api_filter_view_patch.JsonApiFilterViewPatch + +JSON:API representation of patching filterView entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching filterView entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["filterView", ] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**areRelationsValid** | bool, | BoolClass, | | [optional] +**[content](#content)** | dict, frozendict.frozendict, | frozendict.frozendict, | The respective filter context. | [optional] +**description** | str, | str, | | [optional] +**isDefault** | bool, | BoolClass, | Indicator whether the filter view should by applied by default. | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# content + +The respective filter context. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | The respective filter context. | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[analyticalDashboard](#analyticalDashboard)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[user](#user)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# analyticalDashboard + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# user + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserToOneLinkage**](JsonApiUserToOneLinkage.md) | [**JsonApiUserToOneLinkage**](JsonApiUserToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiFilterViewPatchDocument.md b/gooddata-api-client/docs/models/JsonApiFilterViewPatchDocument.md new file mode 100644 index 000000000..ce42e6d30 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiFilterViewPatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_filter_view_patch_document.JsonApiFilterViewPatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiFilterViewPatch**](JsonApiFilterViewPatch.md) | [**JsonApiFilterViewPatch**](JsonApiFilterViewPatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiIdentityProviderIn.md b/gooddata-api-client/docs/models/JsonApiIdentityProviderIn.md new file mode 100644 index 000000000..8ffc19ec7 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiIdentityProviderIn.md @@ -0,0 +1,98 @@ +# gooddata_api_client.model.json_api_identity_provider_in.JsonApiIdentityProviderIn + +JSON:API representation of identityProvider entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of identityProvider entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["identityProvider", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[customClaimMapping](#customClaimMapping)** | dict, frozendict.frozendict, | frozendict.frozendict, | Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. | [optional] +**[identifiers](#identifiers)** | list, tuple, | tuple, | List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. | [optional] +**idpType** | str, | str, | Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise. | [optional] must be one of ["MANAGED_IDP", "FIM_IDP", "DEX_IDP", "CUSTOM_IDP", ] +**oauthClientId** | str, | str, | The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] +**oauthClientSecret** | str, | str, | The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] +**[oauthCustomAuthAttributes](#oauthCustomAuthAttributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] +**[oauthCustomScopes](#oauthCustomScopes)** | list, tuple, None, | tuple, NoneClass, | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] +**oauthIssuerId** | str, | str, | Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider. | [optional] +**oauthIssuerLocation** | str, | str, | The location of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] +**oauthSubjectIdClaim** | str, | str, | Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'. | [optional] +**samlMetadata** | str, | str, | Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# customClaimMapping + +Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional] + +# identifiers + +List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# oauthCustomAuthAttributes + +Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional] + +# oauthCustomScopes + +List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, None, | tuple, NoneClass, | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiIdentityProviderInDocument.md b/gooddata-api-client/docs/models/JsonApiIdentityProviderInDocument.md new file mode 100644 index 000000000..874176a0e --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiIdentityProviderInDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_identity_provider_in_document.JsonApiIdentityProviderInDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiIdentityProviderIn**](JsonApiIdentityProviderIn.md) | [**JsonApiIdentityProviderIn**](JsonApiIdentityProviderIn.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiIdentityProviderLinkage.md b/gooddata-api-client/docs/models/JsonApiIdentityProviderLinkage.md new file mode 100644 index 000000000..30ede15de --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiIdentityProviderLinkage.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.json_api_identity_provider_linkage.JsonApiIdentityProviderLinkage + +The \\\"type\\\" and \\\"id\\\" to non-empty members. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | The \\\"type\\\" and \\\"id\\\" to non-empty members. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**type** | str, | str, | | must be one of ["identityProvider", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiIdentityProviderOut.md b/gooddata-api-client/docs/models/JsonApiIdentityProviderOut.md new file mode 100644 index 000000000..7d58c7449 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiIdentityProviderOut.md @@ -0,0 +1,96 @@ +# gooddata_api_client.model.json_api_identity_provider_out.JsonApiIdentityProviderOut + +JSON:API representation of identityProvider entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of identityProvider entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["identityProvider", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[customClaimMapping](#customClaimMapping)** | dict, frozendict.frozendict, | frozendict.frozendict, | Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. | [optional] +**[identifiers](#identifiers)** | list, tuple, | tuple, | List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. | [optional] +**idpType** | str, | str, | Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise. | [optional] must be one of ["MANAGED_IDP", "FIM_IDP", "DEX_IDP", "CUSTOM_IDP", ] +**oauthClientId** | str, | str, | The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] +**[oauthCustomAuthAttributes](#oauthCustomAuthAttributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] +**[oauthCustomScopes](#oauthCustomScopes)** | list, tuple, None, | tuple, NoneClass, | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] +**oauthIssuerId** | str, | str, | Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider. | [optional] +**oauthIssuerLocation** | str, | str, | The location of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] +**oauthSubjectIdClaim** | str, | str, | Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# customClaimMapping + +Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional] + +# identifiers + +List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# oauthCustomAuthAttributes + +Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional] + +# oauthCustomScopes + +List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, None, | tuple, NoneClass, | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiIdentityProviderOutDocument.md b/gooddata-api-client/docs/models/JsonApiIdentityProviderOutDocument.md new file mode 100644 index 000000000..bef7cf61b --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiIdentityProviderOutDocument.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_identity_provider_out_document.JsonApiIdentityProviderOutDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiIdentityProviderOut**](JsonApiIdentityProviderOut.md) | [**JsonApiIdentityProviderOut**](JsonApiIdentityProviderOut.md) | | +**links** | [**ObjectLinks**](ObjectLinks.md) | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiIdentityProviderOutList.md b/gooddata-api-client/docs/models/JsonApiIdentityProviderOutList.md new file mode 100644 index 000000000..77595d9a3 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiIdentityProviderOutList.md @@ -0,0 +1,44 @@ +# gooddata_api_client.model.json_api_identity_provider_out_list.JsonApiIdentityProviderOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiIdentityProviderOutWithLinks**](JsonApiIdentityProviderOutWithLinks.md) | [**JsonApiIdentityProviderOutWithLinks**](JsonApiIdentityProviderOutWithLinks.md) | [**JsonApiIdentityProviderOutWithLinks**](JsonApiIdentityProviderOutWithLinks.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiIdentityProviderOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiIdentityProviderOutWithLinks.md new file mode 100644 index 000000000..f84bbcc4b --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiIdentityProviderOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_identity_provider_out_with_links.JsonApiIdentityProviderOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiIdentityProviderOut](JsonApiIdentityProviderOut.md) | [**JsonApiIdentityProviderOut**](JsonApiIdentityProviderOut.md) | [**JsonApiIdentityProviderOut**](JsonApiIdentityProviderOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiIdentityProviderPatch.md b/gooddata-api-client/docs/models/JsonApiIdentityProviderPatch.md new file mode 100644 index 000000000..8764ef8c2 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiIdentityProviderPatch.md @@ -0,0 +1,98 @@ +# gooddata_api_client.model.json_api_identity_provider_patch.JsonApiIdentityProviderPatch + +JSON:API representation of patching identityProvider entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching identityProvider entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["identityProvider", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[customClaimMapping](#customClaimMapping)** | dict, frozendict.frozendict, | frozendict.frozendict, | Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. | [optional] +**[identifiers](#identifiers)** | list, tuple, | tuple, | List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. | [optional] +**idpType** | str, | str, | Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise. | [optional] must be one of ["MANAGED_IDP", "FIM_IDP", "DEX_IDP", "CUSTOM_IDP", ] +**oauthClientId** | str, | str, | The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] +**oauthClientSecret** | str, | str, | The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] +**[oauthCustomAuthAttributes](#oauthCustomAuthAttributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] +**[oauthCustomScopes](#oauthCustomScopes)** | list, tuple, None, | tuple, NoneClass, | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | [optional] +**oauthIssuerId** | str, | str, | Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider. | [optional] +**oauthIssuerLocation** | str, | str, | The location of your OIDC provider. This field is mandatory for OIDC IdP. | [optional] +**oauthSubjectIdClaim** | str, | str, | Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'. | [optional] +**samlMetadata** | str, | str, | Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# customClaimMapping + +Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional] + +# identifiers + +List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# oauthCustomAuthAttributes + +Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional] + +# oauthCustomScopes + +List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, None, | tuple, NoneClass, | List of additional OAuth scopes which may be required by other providers (e.g. Snowflake) | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiIdentityProviderPatchDocument.md b/gooddata-api-client/docs/models/JsonApiIdentityProviderPatchDocument.md new file mode 100644 index 000000000..02c96168c --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiIdentityProviderPatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_identity_provider_patch_document.JsonApiIdentityProviderPatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiIdentityProviderPatch**](JsonApiIdentityProviderPatch.md) | [**JsonApiIdentityProviderPatch**](JsonApiIdentityProviderPatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiIdentityProviderToOneLinkage.md b/gooddata-api-client/docs/models/JsonApiIdentityProviderToOneLinkage.md new file mode 100644 index 000000000..30d062d38 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiIdentityProviderToOneLinkage.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.json_api_identity_provider_to_one_linkage.JsonApiIdentityProviderToOneLinkage + +References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiIdentityProviderLinkage](JsonApiIdentityProviderLinkage.md) | [**JsonApiIdentityProviderLinkage**](JsonApiIdentityProviderLinkage.md) | [**JsonApiIdentityProviderLinkage**](JsonApiIdentityProviderLinkage.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiJwkIn.md b/gooddata-api-client/docs/models/JsonApiJwkIn.md new file mode 100644 index 000000000..e25c52529 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiJwkIn.md @@ -0,0 +1,47 @@ +# gooddata_api_client.model.json_api_jwk_in.JsonApiJwkIn + +JSON:API representation of jwk entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of jwk entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["jwk", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[content](#content)** | dict, frozendict.frozendict, | frozendict.frozendict, | Specification of the cryptographic key | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# content + +Specification of the cryptographic key + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Specification of the cryptographic key | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[RsaSpecification](RsaSpecification.md) | [**RsaSpecification**](RsaSpecification.md) | [**RsaSpecification**](RsaSpecification.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiJwkInDocument.md b/gooddata-api-client/docs/models/JsonApiJwkInDocument.md new file mode 100644 index 000000000..b1b3f0f91 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiJwkInDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_jwk_in_document.JsonApiJwkInDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiJwkIn**](JsonApiJwkIn.md) | [**JsonApiJwkIn**](JsonApiJwkIn.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiJwkOut.md b/gooddata-api-client/docs/models/JsonApiJwkOut.md new file mode 100644 index 000000000..01cd7a27d --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiJwkOut.md @@ -0,0 +1,47 @@ +# gooddata_api_client.model.json_api_jwk_out.JsonApiJwkOut + +JSON:API representation of jwk entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of jwk entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["jwk", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[content](#content)** | dict, frozendict.frozendict, | frozendict.frozendict, | Specification of the cryptographic key | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# content + +Specification of the cryptographic key + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Specification of the cryptographic key | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[RsaSpecification](RsaSpecification.md) | [**RsaSpecification**](RsaSpecification.md) | [**RsaSpecification**](RsaSpecification.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiJwkOutDocument.md b/gooddata-api-client/docs/models/JsonApiJwkOutDocument.md new file mode 100644 index 000000000..40f61a19a --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiJwkOutDocument.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_jwk_out_document.JsonApiJwkOutDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiJwkOut**](JsonApiJwkOut.md) | [**JsonApiJwkOut**](JsonApiJwkOut.md) | | +**links** | [**ObjectLinks**](ObjectLinks.md) | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiJwkOutList.md b/gooddata-api-client/docs/models/JsonApiJwkOutList.md new file mode 100644 index 000000000..8e3e38a6b --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiJwkOutList.md @@ -0,0 +1,44 @@ +# gooddata_api_client.model.json_api_jwk_out_list.JsonApiJwkOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiJwkOutWithLinks**](JsonApiJwkOutWithLinks.md) | [**JsonApiJwkOutWithLinks**](JsonApiJwkOutWithLinks.md) | [**JsonApiJwkOutWithLinks**](JsonApiJwkOutWithLinks.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiJwkOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiJwkOutWithLinks.md new file mode 100644 index 000000000..472e932f2 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiJwkOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_jwk_out_with_links.JsonApiJwkOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiJwkOut](JsonApiJwkOut.md) | [**JsonApiJwkOut**](JsonApiJwkOut.md) | [**JsonApiJwkOut**](JsonApiJwkOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiJwkPatch.md b/gooddata-api-client/docs/models/JsonApiJwkPatch.md new file mode 100644 index 000000000..96e1541a0 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiJwkPatch.md @@ -0,0 +1,47 @@ +# gooddata_api_client.model.json_api_jwk_patch.JsonApiJwkPatch + +JSON:API representation of patching jwk entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching jwk entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["jwk", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[content](#content)** | dict, frozendict.frozendict, | frozendict.frozendict, | Specification of the cryptographic key | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# content + +Specification of the cryptographic key + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Specification of the cryptographic key | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[RsaSpecification](RsaSpecification.md) | [**RsaSpecification**](RsaSpecification.md) | [**RsaSpecification**](RsaSpecification.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiJwkPatchDocument.md b/gooddata-api-client/docs/models/JsonApiJwkPatchDocument.md new file mode 100644 index 000000000..e388856cb --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiJwkPatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_jwk_patch_document.JsonApiJwkPatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiJwkPatch**](JsonApiJwkPatch.md) | [**JsonApiJwkPatch**](JsonApiJwkPatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationIn.md b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationIn.md new file mode 100644 index 000000000..882762a88 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationIn.md @@ -0,0 +1,110 @@ +# gooddata_api_client.model.json_api_knowledge_recommendation_in.JsonApiKnowledgeRecommendationIn + +JSON:API representation of knowledgeRecommendation entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of knowledgeRecommendation entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["knowledgeRecommendation", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**comparisonType** | str, | str, | Time period for comparison | must be one of ["MONTH", "QUARTER", "YEAR", ] +**title** | str, | str, | Human-readable title for the recommendation, e.g. 'Revenue decreased vs last month' | +**direction** | str, | str, | Direction of the metric change | must be one of ["INCREASED", "DECREASED", ] +**analyticalDashboardTitle** | str, | str, | Human-readable title of the analytical dashboard (denormalized for display) | [optional] +**analyzedPeriod** | str, | str, | Analyzed time period (e.g., '2023-07' or 'July 2023') | [optional] +**analyzedValue** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Metric value in the analyzed period (the observed value that triggered the anomaly) | [optional] +**areRelationsValid** | bool, | BoolClass, | | [optional] +**confidence** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Confidence score (0.0 to 1.0) | [optional] +**description** | str, | str, | Description of the recommendation | [optional] +**metricTitle** | str, | str, | Human-readable title of the metric (denormalized for display) | [optional] +**[recommendations](#recommendations)** | dict, frozendict.frozendict, | frozendict.frozendict, | Structured recommendations data as JSON | [optional] +**referencePeriod** | str, | str, | Reference time period for comparison (e.g., '2023-06' or 'Jun 2023') | [optional] +**referenceValue** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Metric value in the reference period | [optional] +**sourceCount** | decimal.Decimal, int, | decimal.Decimal, | Number of source documents used for generation | [optional] value must be a 32 bit integer +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**widgetId** | str, | str, | ID of the widget where the anomaly was detected | [optional] +**widgetName** | str, | str, | Name of the widget where the anomaly was detected | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# recommendations + +Structured recommendations data as JSON + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Structured recommendations data as JSON | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[metric](#metric)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**[analyticalDashboard](#analyticalDashboard)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# analyticalDashboard + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# metric + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiMetricToOneLinkage**](JsonApiMetricToOneLinkage.md) | [**JsonApiMetricToOneLinkage**](JsonApiMetricToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationInDocument.md b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationInDocument.md new file mode 100644 index 000000000..eba8f91b8 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationInDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_knowledge_recommendation_in_document.JsonApiKnowledgeRecommendationInDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiKnowledgeRecommendationIn**](JsonApiKnowledgeRecommendationIn.md) | [**JsonApiKnowledgeRecommendationIn**](JsonApiKnowledgeRecommendationIn.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationOut.md b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationOut.md new file mode 100644 index 000000000..cb5bf9030 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationOut.md @@ -0,0 +1,139 @@ +# gooddata_api_client.model.json_api_knowledge_recommendation_out.JsonApiKnowledgeRecommendationOut + +JSON:API representation of knowledgeRecommendation entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of knowledgeRecommendation entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["knowledgeRecommendation", ] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**comparisonType** | str, | str, | Time period for comparison | must be one of ["MONTH", "QUARTER", "YEAR", ] +**title** | str, | str, | Human-readable title for the recommendation, e.g. 'Revenue decreased vs last month' | +**direction** | str, | str, | Direction of the metric change | must be one of ["INCREASED", "DECREASED", ] +**analyticalDashboardTitle** | str, | str, | Human-readable title of the analytical dashboard (denormalized for display) | [optional] +**analyzedPeriod** | str, | str, | Analyzed time period (e.g., '2023-07' or 'July 2023') | [optional] +**analyzedValue** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Metric value in the analyzed period (the observed value that triggered the anomaly) | [optional] +**areRelationsValid** | bool, | BoolClass, | | [optional] +**confidence** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Confidence score (0.0 to 1.0) | [optional] +**createdAt** | str, datetime, | str, | | [optional] value must conform to RFC-3339 date-time +**description** | str, | str, | Description of the recommendation | [optional] +**metricTitle** | str, | str, | Human-readable title of the metric (denormalized for display) | [optional] +**[recommendations](#recommendations)** | dict, frozendict.frozendict, | frozendict.frozendict, | Structured recommendations data as JSON | [optional] +**referencePeriod** | str, | str, | Reference time period for comparison (e.g., '2023-06' or 'Jun 2023') | [optional] +**referenceValue** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Metric value in the reference period | [optional] +**sourceCount** | decimal.Decimal, int, | decimal.Decimal, | Number of source documents used for generation | [optional] value must be a 32 bit integer +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**widgetId** | str, | str, | ID of the widget where the anomaly was detected | [optional] +**widgetName** | str, | str, | Name of the widget where the anomaly was detected | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# recommendations + +Structured recommendations data as JSON + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Structured recommendations data as JSON | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[origin](#origin)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# origin + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**originType** | str, | str, | defines type of the origin of the entity | must be one of ["NATIVE", "PARENT", ] +**originId** | str, | str, | defines id of the workspace where the entity comes from | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[analyticalDashboard](#analyticalDashboard)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[metric](#metric)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# analyticalDashboard + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# metric + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiMetricToOneLinkage**](JsonApiMetricToOneLinkage.md) | [**JsonApiMetricToOneLinkage**](JsonApiMetricToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationOutDocument.md b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationOutDocument.md new file mode 100644 index 000000000..b73be61cf --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationOutDocument.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.json_api_knowledge_recommendation_out_document.JsonApiKnowledgeRecommendationOutDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiKnowledgeRecommendationOut**](JsonApiKnowledgeRecommendationOut.md) | [**JsonApiKnowledgeRecommendationOut**](JsonApiKnowledgeRecommendationOut.md) | | +**[included](#included)** | list, tuple, | tuple, | Included resources | [optional] +**links** | [**ObjectLinks**](ObjectLinks.md) | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# included + +Included resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included resources | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationOutIncludes**](JsonApiKnowledgeRecommendationOutIncludes.md) | [**JsonApiKnowledgeRecommendationOutIncludes**](JsonApiKnowledgeRecommendationOutIncludes.md) | [**JsonApiKnowledgeRecommendationOutIncludes**](JsonApiKnowledgeRecommendationOutIncludes.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationOutIncludes.md b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationOutIncludes.md new file mode 100644 index 000000000..da52271e7 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationOutIncludes.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_knowledge_recommendation_out_includes.JsonApiKnowledgeRecommendationOutIncludes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiMetricOutWithLinks](JsonApiMetricOutWithLinks.md) | [**JsonApiMetricOutWithLinks**](JsonApiMetricOutWithLinks.md) | [**JsonApiMetricOutWithLinks**](JsonApiMetricOutWithLinks.md) | | +[JsonApiAnalyticalDashboardOutWithLinks](JsonApiAnalyticalDashboardOutWithLinks.md) | [**JsonApiAnalyticalDashboardOutWithLinks**](JsonApiAnalyticalDashboardOutWithLinks.md) | [**JsonApiAnalyticalDashboardOutWithLinks**](JsonApiAnalyticalDashboardOutWithLinks.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationOutList.md b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationOutList.md new file mode 100644 index 000000000..02482647b --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationOutList.md @@ -0,0 +1,59 @@ +# gooddata_api_client.model.json_api_knowledge_recommendation_out_list.JsonApiKnowledgeRecommendationOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**[included](#included)** | list, tuple, | tuple, | Included resources | [optional] +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationOutWithLinks**](JsonApiKnowledgeRecommendationOutWithLinks.md) | [**JsonApiKnowledgeRecommendationOutWithLinks**](JsonApiKnowledgeRecommendationOutWithLinks.md) | [**JsonApiKnowledgeRecommendationOutWithLinks**](JsonApiKnowledgeRecommendationOutWithLinks.md) | | + +# included + +Included resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included resources | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiKnowledgeRecommendationOutIncludes**](JsonApiKnowledgeRecommendationOutIncludes.md) | [**JsonApiKnowledgeRecommendationOutIncludes**](JsonApiKnowledgeRecommendationOutIncludes.md) | [**JsonApiKnowledgeRecommendationOutIncludes**](JsonApiKnowledgeRecommendationOutIncludes.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationOutWithLinks.md new file mode 100644 index 000000000..a2dbb0d6c --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_knowledge_recommendation_out_with_links.JsonApiKnowledgeRecommendationOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiKnowledgeRecommendationOut](JsonApiKnowledgeRecommendationOut.md) | [**JsonApiKnowledgeRecommendationOut**](JsonApiKnowledgeRecommendationOut.md) | [**JsonApiKnowledgeRecommendationOut**](JsonApiKnowledgeRecommendationOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationPatch.md b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationPatch.md new file mode 100644 index 000000000..5c2901b4e --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationPatch.md @@ -0,0 +1,110 @@ +# gooddata_api_client.model.json_api_knowledge_recommendation_patch.JsonApiKnowledgeRecommendationPatch + +JSON:API representation of patching knowledgeRecommendation entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching knowledgeRecommendation entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["knowledgeRecommendation", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**analyticalDashboardTitle** | str, | str, | Human-readable title of the analytical dashboard (denormalized for display) | [optional] +**analyzedPeriod** | str, | str, | Analyzed time period (e.g., '2023-07' or 'July 2023') | [optional] +**analyzedValue** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Metric value in the analyzed period (the observed value that triggered the anomaly) | [optional] +**areRelationsValid** | bool, | BoolClass, | | [optional] +**comparisonType** | str, | str, | Time period for comparison | [optional] must be one of ["MONTH", "QUARTER", "YEAR", ] +**confidence** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Confidence score (0.0 to 1.0) | [optional] +**description** | str, | str, | Description of the recommendation | [optional] +**direction** | str, | str, | Direction of the metric change | [optional] must be one of ["INCREASED", "DECREASED", ] +**metricTitle** | str, | str, | Human-readable title of the metric (denormalized for display) | [optional] +**[recommendations](#recommendations)** | dict, frozendict.frozendict, | frozendict.frozendict, | Structured recommendations data as JSON | [optional] +**referencePeriod** | str, | str, | Reference time period for comparison (e.g., '2023-06' or 'Jun 2023') | [optional] +**referenceValue** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Metric value in the reference period | [optional] +**sourceCount** | decimal.Decimal, int, | decimal.Decimal, | Number of source documents used for generation | [optional] value must be a 32 bit integer +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | Human-readable title for the recommendation, e.g. 'Revenue decreased vs last month' | [optional] +**widgetId** | str, | str, | ID of the widget where the anomaly was detected | [optional] +**widgetName** | str, | str, | Name of the widget where the anomaly was detected | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# recommendations + +Structured recommendations data as JSON + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Structured recommendations data as JSON | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[analyticalDashboard](#analyticalDashboard)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[metric](#metric)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# analyticalDashboard + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# metric + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiMetricToOneLinkage**](JsonApiMetricToOneLinkage.md) | [**JsonApiMetricToOneLinkage**](JsonApiMetricToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationPatchDocument.md b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationPatchDocument.md new file mode 100644 index 000000000..296001d09 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationPatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_knowledge_recommendation_patch_document.JsonApiKnowledgeRecommendationPatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiKnowledgeRecommendationPatch**](JsonApiKnowledgeRecommendationPatch.md) | [**JsonApiKnowledgeRecommendationPatch**](JsonApiKnowledgeRecommendationPatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationPostOptionalId.md b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationPostOptionalId.md new file mode 100644 index 000000000..cf507a440 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationPostOptionalId.md @@ -0,0 +1,110 @@ +# gooddata_api_client.model.json_api_knowledge_recommendation_post_optional_id.JsonApiKnowledgeRecommendationPostOptionalId + +JSON:API representation of knowledgeRecommendation entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of knowledgeRecommendation entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**type** | str, | str, | Object type | must be one of ["knowledgeRecommendation", ] +**id** | str, | str, | API identifier of an object | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**comparisonType** | str, | str, | Time period for comparison | must be one of ["MONTH", "QUARTER", "YEAR", ] +**title** | str, | str, | Human-readable title for the recommendation, e.g. 'Revenue decreased vs last month' | +**direction** | str, | str, | Direction of the metric change | must be one of ["INCREASED", "DECREASED", ] +**analyticalDashboardTitle** | str, | str, | Human-readable title of the analytical dashboard (denormalized for display) | [optional] +**analyzedPeriod** | str, | str, | Analyzed time period (e.g., '2023-07' or 'July 2023') | [optional] +**analyzedValue** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Metric value in the analyzed period (the observed value that triggered the anomaly) | [optional] +**areRelationsValid** | bool, | BoolClass, | | [optional] +**confidence** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Confidence score (0.0 to 1.0) | [optional] +**description** | str, | str, | Description of the recommendation | [optional] +**metricTitle** | str, | str, | Human-readable title of the metric (denormalized for display) | [optional] +**[recommendations](#recommendations)** | dict, frozendict.frozendict, | frozendict.frozendict, | Structured recommendations data as JSON | [optional] +**referencePeriod** | str, | str, | Reference time period for comparison (e.g., '2023-06' or 'Jun 2023') | [optional] +**referenceValue** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Metric value in the reference period | [optional] +**sourceCount** | decimal.Decimal, int, | decimal.Decimal, | Number of source documents used for generation | [optional] value must be a 32 bit integer +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**widgetId** | str, | str, | ID of the widget where the anomaly was detected | [optional] +**widgetName** | str, | str, | Name of the widget where the anomaly was detected | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# recommendations + +Structured recommendations data as JSON + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Structured recommendations data as JSON | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[metric](#metric)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**[analyticalDashboard](#analyticalDashboard)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# analyticalDashboard + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# metric + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiMetricToOneLinkage**](JsonApiMetricToOneLinkage.md) | [**JsonApiMetricToOneLinkage**](JsonApiMetricToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationPostOptionalIdDocument.md b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationPostOptionalIdDocument.md new file mode 100644 index 000000000..83c7b2474 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiKnowledgeRecommendationPostOptionalIdDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_knowledge_recommendation_post_optional_id_document.JsonApiKnowledgeRecommendationPostOptionalIdDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiKnowledgeRecommendationPostOptionalId**](JsonApiKnowledgeRecommendationPostOptionalId.md) | [**JsonApiKnowledgeRecommendationPostOptionalId**](JsonApiKnowledgeRecommendationPostOptionalId.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLabelPatch.md b/gooddata-api-client/docs/models/JsonApiLabelPatch.md new file mode 100644 index 000000000..0be357647 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLabelPatch.md @@ -0,0 +1,46 @@ +# gooddata_api_client.model.json_api_label_patch.JsonApiLabelPatch + +JSON:API representation of patching label entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching label entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["label", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**description** | str, | str, | | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLabelPatchDocument.md b/gooddata-api-client/docs/models/JsonApiLabelPatchDocument.md new file mode 100644 index 000000000..ef98847eb --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLabelPatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_label_patch_document.JsonApiLabelPatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiLabelPatch**](JsonApiLabelPatch.md) | [**JsonApiLabelPatch**](JsonApiLabelPatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLlmEndpointIn.md b/gooddata-api-client/docs/models/JsonApiLlmEndpointIn.md new file mode 100644 index 000000000..1cd42b797 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLlmEndpointIn.md @@ -0,0 +1,37 @@ +# gooddata_api_client.model.json_api_llm_endpoint_in.JsonApiLlmEndpointIn + +JSON:API representation of llmEndpoint entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of llmEndpoint entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["llmEndpoint", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**title** | str, | str, | User-facing title of the LLM Provider. | +**token** | str, | str, | The token to use to connect to the LLM provider. | +**baseUrl** | None, str, | NoneClass, str, | Custom LLM endpoint. | [optional] +**llmModel** | str, | str, | LLM Model. We provide a default model for each provider, but you can override it here. | [optional] +**llmOrganization** | None, str, | NoneClass, str, | Organization in LLM provider. | [optional] +**provider** | str, | str, | LLM Provider. | [optional] must be one of ["OPENAI", "AZURE_OPENAI", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLlmEndpointInDocument.md b/gooddata-api-client/docs/models/JsonApiLlmEndpointInDocument.md new file mode 100644 index 000000000..51551176f --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLlmEndpointInDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_llm_endpoint_in_document.JsonApiLlmEndpointInDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiLlmEndpointIn**](JsonApiLlmEndpointIn.md) | [**JsonApiLlmEndpointIn**](JsonApiLlmEndpointIn.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLlmEndpointOut.md b/gooddata-api-client/docs/models/JsonApiLlmEndpointOut.md new file mode 100644 index 000000000..072ac2d1d --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLlmEndpointOut.md @@ -0,0 +1,36 @@ +# gooddata_api_client.model.json_api_llm_endpoint_out.JsonApiLlmEndpointOut + +JSON:API representation of llmEndpoint entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of llmEndpoint entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["llmEndpoint", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**title** | str, | str, | User-facing title of the LLM Provider. | +**baseUrl** | None, str, | NoneClass, str, | Custom LLM endpoint. | [optional] +**llmModel** | str, | str, | LLM Model. We provide a default model for each provider, but you can override it here. | [optional] +**llmOrganization** | None, str, | NoneClass, str, | Organization in LLM provider. | [optional] +**provider** | str, | str, | LLM Provider. | [optional] must be one of ["OPENAI", "AZURE_OPENAI", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLlmEndpointOutDocument.md b/gooddata-api-client/docs/models/JsonApiLlmEndpointOutDocument.md new file mode 100644 index 000000000..3942b62c5 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLlmEndpointOutDocument.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_llm_endpoint_out_document.JsonApiLlmEndpointOutDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiLlmEndpointOut**](JsonApiLlmEndpointOut.md) | [**JsonApiLlmEndpointOut**](JsonApiLlmEndpointOut.md) | | +**links** | [**ObjectLinks**](ObjectLinks.md) | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLlmEndpointOutList.md b/gooddata-api-client/docs/models/JsonApiLlmEndpointOutList.md new file mode 100644 index 000000000..3d2e6c0b6 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLlmEndpointOutList.md @@ -0,0 +1,44 @@ +# gooddata_api_client.model.json_api_llm_endpoint_out_list.JsonApiLlmEndpointOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiLlmEndpointOutWithLinks**](JsonApiLlmEndpointOutWithLinks.md) | [**JsonApiLlmEndpointOutWithLinks**](JsonApiLlmEndpointOutWithLinks.md) | [**JsonApiLlmEndpointOutWithLinks**](JsonApiLlmEndpointOutWithLinks.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLlmEndpointOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiLlmEndpointOutWithLinks.md new file mode 100644 index 000000000..461c6da5a --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLlmEndpointOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_llm_endpoint_out_with_links.JsonApiLlmEndpointOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiLlmEndpointOut](JsonApiLlmEndpointOut.md) | [**JsonApiLlmEndpointOut**](JsonApiLlmEndpointOut.md) | [**JsonApiLlmEndpointOut**](JsonApiLlmEndpointOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLlmEndpointPatch.md b/gooddata-api-client/docs/models/JsonApiLlmEndpointPatch.md new file mode 100644 index 000000000..349ada0b2 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLlmEndpointPatch.md @@ -0,0 +1,37 @@ +# gooddata_api_client.model.json_api_llm_endpoint_patch.JsonApiLlmEndpointPatch + +JSON:API representation of patching llmEndpoint entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching llmEndpoint entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["llmEndpoint", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**baseUrl** | None, str, | NoneClass, str, | Custom LLM endpoint. | [optional] +**llmModel** | str, | str, | LLM Model. We provide a default model for each provider, but you can override it here. | [optional] +**llmOrganization** | None, str, | NoneClass, str, | Organization in LLM provider. | [optional] +**provider** | str, | str, | LLM Provider. | [optional] must be one of ["OPENAI", "AZURE_OPENAI", ] +**title** | str, | str, | User-facing title of the LLM Provider. | [optional] +**token** | str, | str, | The token to use to connect to the LLM provider. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLlmEndpointPatchDocument.md b/gooddata-api-client/docs/models/JsonApiLlmEndpointPatchDocument.md new file mode 100644 index 000000000..b89f34cf1 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLlmEndpointPatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_llm_endpoint_patch_document.JsonApiLlmEndpointPatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiLlmEndpointPatch**](JsonApiLlmEndpointPatch.md) | [**JsonApiLlmEndpointPatch**](JsonApiLlmEndpointPatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLlmProviderIn.md b/gooddata-api-client/docs/models/JsonApiLlmProviderIn.md new file mode 100644 index 000000000..fe2d8b7b2 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLlmProviderIn.md @@ -0,0 +1,83 @@ +# gooddata_api_client.model.json_api_llm_provider_in.JsonApiLlmProviderIn + +LLM Provider configuration for connecting to LLM services. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | LLM Provider configuration for connecting to LLM services. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["llmProvider", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[models](#models)** | list, tuple, None, | tuple, NoneClass, | List of LLM models available for this provider. | +**[providerConfig](#providerConfig)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Provider-specific configuration including authentication. | +**defaultModelId** | None, str, | NoneClass, str, | ID of the default model to use from the models list. | [optional] +**description** | None, str, | NoneClass, str, | Description of the LLM Provider. | [optional] +**name** | None, str, | NoneClass, str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# models + +List of LLM models available for this provider. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, None, | tuple, NoneClass, | List of LLM models available for this provider. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | LLM Model configuration (id, family) within a provider. | + +# items + +LLM Model configuration (id, family) within a provider. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | LLM Model configuration (id, family) within a provider. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Unique identifier of the model (e.g., gpt-5.3, claude-4.6). | +**family** | str, | str, | Family of LLM models. | must be one of ["OPENAI", "ANTHROPIC", "META", "MISTRAL", "AMAZON", "GOOGLE", "COHERE", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# providerConfig + +Provider-specific configuration including authentication. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Provider-specific configuration including authentication. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AwsBedrockProviderConfig](AwsBedrockProviderConfig.md) | [**AwsBedrockProviderConfig**](AwsBedrockProviderConfig.md) | [**AwsBedrockProviderConfig**](AwsBedrockProviderConfig.md) | | +[AzureFoundryProviderConfig](AzureFoundryProviderConfig.md) | [**AzureFoundryProviderConfig**](AzureFoundryProviderConfig.md) | [**AzureFoundryProviderConfig**](AzureFoundryProviderConfig.md) | | +[OpenAIProviderConfig](OpenAIProviderConfig.md) | [**OpenAIProviderConfig**](OpenAIProviderConfig.md) | [**OpenAIProviderConfig**](OpenAIProviderConfig.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLlmProviderInDocument.md b/gooddata-api-client/docs/models/JsonApiLlmProviderInDocument.md new file mode 100644 index 000000000..0ada03f72 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLlmProviderInDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_llm_provider_in_document.JsonApiLlmProviderInDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiLlmProviderIn**](JsonApiLlmProviderIn.md) | [**JsonApiLlmProviderIn**](JsonApiLlmProviderIn.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLlmProviderOut.md b/gooddata-api-client/docs/models/JsonApiLlmProviderOut.md new file mode 100644 index 000000000..46c58680f --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLlmProviderOut.md @@ -0,0 +1,83 @@ +# gooddata_api_client.model.json_api_llm_provider_out.JsonApiLlmProviderOut + +LLM Provider configuration for connecting to LLM services. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | LLM Provider configuration for connecting to LLM services. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["llmProvider", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[models](#models)** | list, tuple, None, | tuple, NoneClass, | List of LLM models available for this provider. | +**[providerConfig](#providerConfig)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Provider-specific configuration including authentication. | +**defaultModelId** | None, str, | NoneClass, str, | ID of the default model to use from the models list. | [optional] +**description** | None, str, | NoneClass, str, | Description of the LLM Provider. | [optional] +**name** | None, str, | NoneClass, str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# models + +List of LLM models available for this provider. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, None, | tuple, NoneClass, | List of LLM models available for this provider. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | LLM Model configuration (id, family) within a provider. | + +# items + +LLM Model configuration (id, family) within a provider. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | LLM Model configuration (id, family) within a provider. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Unique identifier of the model (e.g., gpt-5.3, claude-4.6). | +**family** | str, | str, | Family of LLM models. | must be one of ["OPENAI", "ANTHROPIC", "META", "MISTRAL", "AMAZON", "GOOGLE", "COHERE", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# providerConfig + +Provider-specific configuration including authentication. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Provider-specific configuration including authentication. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AwsBedrockProviderConfig](AwsBedrockProviderConfig.md) | [**AwsBedrockProviderConfig**](AwsBedrockProviderConfig.md) | [**AwsBedrockProviderConfig**](AwsBedrockProviderConfig.md) | | +[AzureFoundryProviderConfig](AzureFoundryProviderConfig.md) | [**AzureFoundryProviderConfig**](AzureFoundryProviderConfig.md) | [**AzureFoundryProviderConfig**](AzureFoundryProviderConfig.md) | | +[OpenAIProviderConfig](OpenAIProviderConfig.md) | [**OpenAIProviderConfig**](OpenAIProviderConfig.md) | [**OpenAIProviderConfig**](OpenAIProviderConfig.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLlmProviderOutDocument.md b/gooddata-api-client/docs/models/JsonApiLlmProviderOutDocument.md new file mode 100644 index 000000000..bd21bf87b --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLlmProviderOutDocument.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_llm_provider_out_document.JsonApiLlmProviderOutDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiLlmProviderOut**](JsonApiLlmProviderOut.md) | [**JsonApiLlmProviderOut**](JsonApiLlmProviderOut.md) | | +**links** | [**ObjectLinks**](ObjectLinks.md) | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLlmProviderOutList.md b/gooddata-api-client/docs/models/JsonApiLlmProviderOutList.md new file mode 100644 index 000000000..b261bdff6 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLlmProviderOutList.md @@ -0,0 +1,44 @@ +# gooddata_api_client.model.json_api_llm_provider_out_list.JsonApiLlmProviderOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiLlmProviderOutWithLinks**](JsonApiLlmProviderOutWithLinks.md) | [**JsonApiLlmProviderOutWithLinks**](JsonApiLlmProviderOutWithLinks.md) | [**JsonApiLlmProviderOutWithLinks**](JsonApiLlmProviderOutWithLinks.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLlmProviderOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiLlmProviderOutWithLinks.md new file mode 100644 index 000000000..14b8d375d --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLlmProviderOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_llm_provider_out_with_links.JsonApiLlmProviderOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiLlmProviderOut](JsonApiLlmProviderOut.md) | [**JsonApiLlmProviderOut**](JsonApiLlmProviderOut.md) | [**JsonApiLlmProviderOut**](JsonApiLlmProviderOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLlmProviderPatch.md b/gooddata-api-client/docs/models/JsonApiLlmProviderPatch.md new file mode 100644 index 000000000..9157b87c7 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLlmProviderPatch.md @@ -0,0 +1,83 @@ +# gooddata_api_client.model.json_api_llm_provider_patch.JsonApiLlmProviderPatch + +LLM Provider configuration for connecting to LLM services. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | LLM Provider configuration for connecting to LLM services. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["llmProvider", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**defaultModelId** | None, str, | NoneClass, str, | ID of the default model to use from the models list. | [optional] +**description** | None, str, | NoneClass, str, | Description of the LLM Provider. | [optional] +**[models](#models)** | list, tuple, None, | tuple, NoneClass, | List of LLM models available for this provider. | [optional] +**name** | None, str, | NoneClass, str, | | [optional] +**[providerConfig](#providerConfig)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Provider-specific configuration including authentication. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# models + +List of LLM models available for this provider. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, None, | tuple, NoneClass, | List of LLM models available for this provider. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | LLM Model configuration (id, family) within a provider. | + +# items + +LLM Model configuration (id, family) within a provider. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | LLM Model configuration (id, family) within a provider. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Unique identifier of the model (e.g., gpt-5.3, claude-4.6). | +**family** | str, | str, | Family of LLM models. | must be one of ["OPENAI", "ANTHROPIC", "META", "MISTRAL", "AMAZON", "GOOGLE", "COHERE", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# providerConfig + +Provider-specific configuration including authentication. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Provider-specific configuration including authentication. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AwsBedrockProviderConfig](AwsBedrockProviderConfig.md) | [**AwsBedrockProviderConfig**](AwsBedrockProviderConfig.md) | [**AwsBedrockProviderConfig**](AwsBedrockProviderConfig.md) | | +[AzureFoundryProviderConfig](AzureFoundryProviderConfig.md) | [**AzureFoundryProviderConfig**](AzureFoundryProviderConfig.md) | [**AzureFoundryProviderConfig**](AzureFoundryProviderConfig.md) | | +[OpenAIProviderConfig](OpenAIProviderConfig.md) | [**OpenAIProviderConfig**](OpenAIProviderConfig.md) | [**OpenAIProviderConfig**](OpenAIProviderConfig.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiLlmProviderPatchDocument.md b/gooddata-api-client/docs/models/JsonApiLlmProviderPatchDocument.md new file mode 100644 index 000000000..5e140cbea --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiLlmProviderPatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_llm_provider_patch_document.JsonApiLlmProviderPatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiLlmProviderPatch**](JsonApiLlmProviderPatch.md) | [**JsonApiLlmProviderPatch**](JsonApiLlmProviderPatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiMemoryItemIn.md b/gooddata-api-client/docs/models/JsonApiMemoryItemIn.md new file mode 100644 index 000000000..d8e53e277 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiMemoryItemIn.md @@ -0,0 +1,65 @@ +# gooddata_api_client.model.json_api_memory_item_in.JsonApiMemoryItemIn + +JSON:API representation of memoryItem entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of memoryItem entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["memoryItem", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**instruction** | str, | str, | The text that will be injected into the system prompt | +**strategy** | str, | str, | Strategy defining when the memory item should be applied | must be one of ["ALWAYS", "AUTO", ] +**areRelationsValid** | bool, | BoolClass, | | [optional] +**description** | str, | str, | | [optional] +**isDisabled** | bool, | BoolClass, | Whether memory item is disabled | [optional] +**[keywords](#keywords)** | list, tuple, | tuple, | Set of unique strings used for semantic similarity filtering | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# keywords + +Set of unique strings used for semantic similarity filtering + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Set of unique strings used for semantic similarity filtering | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiMemoryItemInDocument.md b/gooddata-api-client/docs/models/JsonApiMemoryItemInDocument.md new file mode 100644 index 000000000..1b86ef00c --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiMemoryItemInDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_memory_item_in_document.JsonApiMemoryItemInDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiMemoryItemIn**](JsonApiMemoryItemIn.md) | [**JsonApiMemoryItemIn**](JsonApiMemoryItemIn.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiMemoryItemOut.md b/gooddata-api-client/docs/models/JsonApiMemoryItemOut.md new file mode 100644 index 000000000..a2b9d2936 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiMemoryItemOut.md @@ -0,0 +1,136 @@ +# gooddata_api_client.model.json_api_memory_item_out.JsonApiMemoryItemOut + +JSON:API representation of memoryItem entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of memoryItem entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["memoryItem", ] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**instruction** | str, | str, | The text that will be injected into the system prompt | +**strategy** | str, | str, | Strategy defining when the memory item should be applied | must be one of ["ALWAYS", "AUTO", ] +**areRelationsValid** | bool, | BoolClass, | | [optional] +**createdAt** | None, str, datetime, | NoneClass, str, | Time of the entity creation. | [optional] value must conform to RFC-3339 date-time +**description** | str, | str, | | [optional] +**isDisabled** | bool, | BoolClass, | Whether memory item is disabled | [optional] +**[keywords](#keywords)** | list, tuple, | tuple, | Set of unique strings used for semantic similarity filtering | [optional] +**modifiedAt** | None, str, datetime, | NoneClass, str, | Time of the last entity modification. | [optional] value must conform to RFC-3339 date-time +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# keywords + +Set of unique strings used for semantic similarity filtering + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Set of unique strings used for semantic similarity filtering | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[origin](#origin)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# origin + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**originType** | str, | str, | defines type of the origin of the entity | must be one of ["NATIVE", "PARENT", ] +**originId** | str, | str, | defines id of the workspace where the entity comes from | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[createdBy](#createdBy)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[modifiedBy](#modifiedBy)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# createdBy + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# modifiedBy + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiMemoryItemOutDocument.md b/gooddata-api-client/docs/models/JsonApiMemoryItemOutDocument.md new file mode 100644 index 000000000..996a0f7a5 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiMemoryItemOutDocument.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.json_api_memory_item_out_document.JsonApiMemoryItemOutDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiMemoryItemOut**](JsonApiMemoryItemOut.md) | [**JsonApiMemoryItemOut**](JsonApiMemoryItemOut.md) | | +**[included](#included)** | list, tuple, | tuple, | Included resources | [optional] +**links** | [**ObjectLinks**](ObjectLinks.md) | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# included + +Included resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included resources | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | [**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | [**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiMemoryItemOutList.md b/gooddata-api-client/docs/models/JsonApiMemoryItemOutList.md new file mode 100644 index 000000000..77a345ce7 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiMemoryItemOutList.md @@ -0,0 +1,59 @@ +# gooddata_api_client.model.json_api_memory_item_out_list.JsonApiMemoryItemOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**[included](#included)** | list, tuple, | tuple, | Included resources | [optional] +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiMemoryItemOutWithLinks**](JsonApiMemoryItemOutWithLinks.md) | [**JsonApiMemoryItemOutWithLinks**](JsonApiMemoryItemOutWithLinks.md) | [**JsonApiMemoryItemOutWithLinks**](JsonApiMemoryItemOutWithLinks.md) | | + +# included + +Included resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included resources | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | [**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | [**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiMemoryItemOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiMemoryItemOutWithLinks.md new file mode 100644 index 000000000..7e48af7f4 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiMemoryItemOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_memory_item_out_with_links.JsonApiMemoryItemOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiMemoryItemOut](JsonApiMemoryItemOut.md) | [**JsonApiMemoryItemOut**](JsonApiMemoryItemOut.md) | [**JsonApiMemoryItemOut**](JsonApiMemoryItemOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiMemoryItemPatch.md b/gooddata-api-client/docs/models/JsonApiMemoryItemPatch.md new file mode 100644 index 000000000..2cd58122f --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiMemoryItemPatch.md @@ -0,0 +1,65 @@ +# gooddata_api_client.model.json_api_memory_item_patch.JsonApiMemoryItemPatch + +JSON:API representation of patching memoryItem entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching memoryItem entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["memoryItem", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**areRelationsValid** | bool, | BoolClass, | | [optional] +**description** | str, | str, | | [optional] +**instruction** | str, | str, | The text that will be injected into the system prompt | [optional] +**isDisabled** | bool, | BoolClass, | Whether memory item is disabled | [optional] +**[keywords](#keywords)** | list, tuple, | tuple, | Set of unique strings used for semantic similarity filtering | [optional] +**strategy** | str, | str, | Strategy defining when the memory item should be applied | [optional] must be one of ["ALWAYS", "AUTO", ] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# keywords + +Set of unique strings used for semantic similarity filtering + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Set of unique strings used for semantic similarity filtering | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiMemoryItemPatchDocument.md b/gooddata-api-client/docs/models/JsonApiMemoryItemPatchDocument.md new file mode 100644 index 000000000..c55f1a492 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiMemoryItemPatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_memory_item_patch_document.JsonApiMemoryItemPatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiMemoryItemPatch**](JsonApiMemoryItemPatch.md) | [**JsonApiMemoryItemPatch**](JsonApiMemoryItemPatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiMemoryItemPostOptionalId.md b/gooddata-api-client/docs/models/JsonApiMemoryItemPostOptionalId.md new file mode 100644 index 000000000..462b63a1d --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiMemoryItemPostOptionalId.md @@ -0,0 +1,65 @@ +# gooddata_api_client.model.json_api_memory_item_post_optional_id.JsonApiMemoryItemPostOptionalId + +JSON:API representation of memoryItem entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of memoryItem entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**type** | str, | str, | Object type | must be one of ["memoryItem", ] +**id** | str, | str, | API identifier of an object | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**instruction** | str, | str, | The text that will be injected into the system prompt | +**strategy** | str, | str, | Strategy defining when the memory item should be applied | must be one of ["ALWAYS", "AUTO", ] +**areRelationsValid** | bool, | BoolClass, | | [optional] +**description** | str, | str, | | [optional] +**isDisabled** | bool, | BoolClass, | Whether memory item is disabled | [optional] +**[keywords](#keywords)** | list, tuple, | tuple, | Set of unique strings used for semantic similarity filtering | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# keywords + +Set of unique strings used for semantic similarity filtering + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Set of unique strings used for semantic similarity filtering | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiMemoryItemPostOptionalIdDocument.md b/gooddata-api-client/docs/models/JsonApiMemoryItemPostOptionalIdDocument.md new file mode 100644 index 000000000..8bbeb792d --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiMemoryItemPostOptionalIdDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_memory_item_post_optional_id_document.JsonApiMemoryItemPostOptionalIdDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiMemoryItemPostOptionalId**](JsonApiMemoryItemPostOptionalId.md) | [**JsonApiMemoryItemPostOptionalId**](JsonApiMemoryItemPostOptionalId.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiMetricToOneLinkage.md b/gooddata-api-client/docs/models/JsonApiMetricToOneLinkage.md new file mode 100644 index 000000000..1e0f8baea --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiMetricToOneLinkage.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.json_api_metric_to_one_linkage.JsonApiMetricToOneLinkage + +References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiMetricLinkage](JsonApiMetricLinkage.md) | [**JsonApiMetricLinkage**](JsonApiMetricLinkage.md) | [**JsonApiMetricLinkage**](JsonApiMetricLinkage.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiNotificationChannelIdentifierOut.md b/gooddata-api-client/docs/models/JsonApiNotificationChannelIdentifierOut.md new file mode 100644 index 000000000..84ff775a8 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiNotificationChannelIdentifierOut.md @@ -0,0 +1,35 @@ +# gooddata_api_client.model.json_api_notification_channel_identifier_out.JsonApiNotificationChannelIdentifierOut + +JSON:API representation of notificationChannelIdentifier entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of notificationChannelIdentifier entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["notificationChannelIdentifier", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**allowedRecipients** | str, | str, | Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization | [optional] must be one of ["CREATOR", "INTERNAL", "EXTERNAL", ] +**description** | None, str, | NoneClass, str, | | [optional] +**destinationType** | str, | str, | | [optional] must be one of ["WEBHOOK", "SMTP", "DEFAULT_SMTP", "IN_PLATFORM", ] +**name** | None, str, | NoneClass, str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiNotificationChannelIdentifierOutDocument.md b/gooddata-api-client/docs/models/JsonApiNotificationChannelIdentifierOutDocument.md new file mode 100644 index 000000000..d80382074 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiNotificationChannelIdentifierOutDocument.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_notification_channel_identifier_out_document.JsonApiNotificationChannelIdentifierOutDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiNotificationChannelIdentifierOut**](JsonApiNotificationChannelIdentifierOut.md) | [**JsonApiNotificationChannelIdentifierOut**](JsonApiNotificationChannelIdentifierOut.md) | | +**links** | [**ObjectLinks**](ObjectLinks.md) | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiNotificationChannelIdentifierOutList.md b/gooddata-api-client/docs/models/JsonApiNotificationChannelIdentifierOutList.md new file mode 100644 index 000000000..3d0ef2fd2 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiNotificationChannelIdentifierOutList.md @@ -0,0 +1,44 @@ +# gooddata_api_client.model.json_api_notification_channel_identifier_out_list.JsonApiNotificationChannelIdentifierOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiNotificationChannelIdentifierOutWithLinks**](JsonApiNotificationChannelIdentifierOutWithLinks.md) | [**JsonApiNotificationChannelIdentifierOutWithLinks**](JsonApiNotificationChannelIdentifierOutWithLinks.md) | [**JsonApiNotificationChannelIdentifierOutWithLinks**](JsonApiNotificationChannelIdentifierOutWithLinks.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiNotificationChannelIdentifierOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiNotificationChannelIdentifierOutWithLinks.md new file mode 100644 index 000000000..fcd05ecac --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiNotificationChannelIdentifierOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_notification_channel_identifier_out_with_links.JsonApiNotificationChannelIdentifierOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiNotificationChannelIdentifierOut](JsonApiNotificationChannelIdentifierOut.md) | [**JsonApiNotificationChannelIdentifierOut**](JsonApiNotificationChannelIdentifierOut.md) | [**JsonApiNotificationChannelIdentifierOut**](JsonApiNotificationChannelIdentifierOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiNotificationChannelIn.md b/gooddata-api-client/docs/models/JsonApiNotificationChannelIn.md new file mode 100644 index 000000000..0e6988f8a --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiNotificationChannelIn.md @@ -0,0 +1,57 @@ +# gooddata_api_client.model.json_api_notification_channel_in.JsonApiNotificationChannelIn + +JSON:API representation of notificationChannel entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of notificationChannel entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["notificationChannel", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**allowedRecipients** | str, | str, | Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization | [optional] must be one of ["CREATOR", "INTERNAL", "EXTERNAL", ] +**customDashboardUrl** | str, | str, | Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} | [optional] +**dashboardLinkVisibility** | str, | str, | Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link | [optional] must be one of ["HIDDEN", "INTERNAL_ONLY", "ALL", ] +**description** | None, str, | NoneClass, str, | | [optional] +**[destination](#destination)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | The destination where the notifications are to be sent. | [optional] +**inPlatformNotification** | str, | str, | In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications | [optional] must be one of ["DISABLED", "ENABLED", ] +**name** | None, str, | NoneClass, str, | | [optional] +**notificationSource** | str, | str, | Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# destination + +The destination where the notifications are to be sent. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | The destination where the notifications are to be sent. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[DefaultSmtp](DefaultSmtp.md) | [**DefaultSmtp**](DefaultSmtp.md) | [**DefaultSmtp**](DefaultSmtp.md) | | +[InPlatform](InPlatform.md) | [**InPlatform**](InPlatform.md) | [**InPlatform**](InPlatform.md) | | +[Smtp](Smtp.md) | [**Smtp**](Smtp.md) | [**Smtp**](Smtp.md) | | +[Webhook](Webhook.md) | [**Webhook**](Webhook.md) | [**Webhook**](Webhook.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiNotificationChannelInDocument.md b/gooddata-api-client/docs/models/JsonApiNotificationChannelInDocument.md new file mode 100644 index 000000000..b3b3cfe42 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiNotificationChannelInDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_notification_channel_in_document.JsonApiNotificationChannelInDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiNotificationChannelIn**](JsonApiNotificationChannelIn.md) | [**JsonApiNotificationChannelIn**](JsonApiNotificationChannelIn.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiNotificationChannelLinkage.md b/gooddata-api-client/docs/models/JsonApiNotificationChannelLinkage.md new file mode 100644 index 000000000..5de348255 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiNotificationChannelLinkage.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.json_api_notification_channel_linkage.JsonApiNotificationChannelLinkage + +The \\\"type\\\" and \\\"id\\\" to non-empty members. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | The \\\"type\\\" and \\\"id\\\" to non-empty members. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**type** | str, | str, | | must be one of ["notificationChannel", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiNotificationChannelOut.md b/gooddata-api-client/docs/models/JsonApiNotificationChannelOut.md new file mode 100644 index 000000000..067f394a4 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiNotificationChannelOut.md @@ -0,0 +1,58 @@ +# gooddata_api_client.model.json_api_notification_channel_out.JsonApiNotificationChannelOut + +JSON:API representation of notificationChannel entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of notificationChannel entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["notificationChannel", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**allowedRecipients** | str, | str, | Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization | [optional] must be one of ["CREATOR", "INTERNAL", "EXTERNAL", ] +**customDashboardUrl** | str, | str, | Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} | [optional] +**dashboardLinkVisibility** | str, | str, | Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link | [optional] must be one of ["HIDDEN", "INTERNAL_ONLY", "ALL", ] +**description** | None, str, | NoneClass, str, | | [optional] +**[destination](#destination)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | The destination where the notifications are to be sent. | [optional] +**destinationType** | None, str, | NoneClass, str, | | [optional] must be one of ["WEBHOOK", "SMTP", "DEFAULT_SMTP", "IN_PLATFORM", ] +**inPlatformNotification** | str, | str, | In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications | [optional] must be one of ["DISABLED", "ENABLED", ] +**name** | None, str, | NoneClass, str, | | [optional] +**notificationSource** | str, | str, | Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# destination + +The destination where the notifications are to be sent. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | The destination where the notifications are to be sent. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[DefaultSmtp](DefaultSmtp.md) | [**DefaultSmtp**](DefaultSmtp.md) | [**DefaultSmtp**](DefaultSmtp.md) | | +[InPlatform](InPlatform.md) | [**InPlatform**](InPlatform.md) | [**InPlatform**](InPlatform.md) | | +[Smtp](Smtp.md) | [**Smtp**](Smtp.md) | [**Smtp**](Smtp.md) | | +[Webhook](Webhook.md) | [**Webhook**](Webhook.md) | [**Webhook**](Webhook.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiNotificationChannelOutDocument.md b/gooddata-api-client/docs/models/JsonApiNotificationChannelOutDocument.md new file mode 100644 index 000000000..8bc8cb3ae --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiNotificationChannelOutDocument.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_notification_channel_out_document.JsonApiNotificationChannelOutDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiNotificationChannelOut**](JsonApiNotificationChannelOut.md) | [**JsonApiNotificationChannelOut**](JsonApiNotificationChannelOut.md) | | +**links** | [**ObjectLinks**](ObjectLinks.md) | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiNotificationChannelOutList.md b/gooddata-api-client/docs/models/JsonApiNotificationChannelOutList.md new file mode 100644 index 000000000..35023619b --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiNotificationChannelOutList.md @@ -0,0 +1,44 @@ +# gooddata_api_client.model.json_api_notification_channel_out_list.JsonApiNotificationChannelOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiNotificationChannelOutWithLinks**](JsonApiNotificationChannelOutWithLinks.md) | [**JsonApiNotificationChannelOutWithLinks**](JsonApiNotificationChannelOutWithLinks.md) | [**JsonApiNotificationChannelOutWithLinks**](JsonApiNotificationChannelOutWithLinks.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiNotificationChannelOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiNotificationChannelOutWithLinks.md new file mode 100644 index 000000000..40f766fec --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiNotificationChannelOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_notification_channel_out_with_links.JsonApiNotificationChannelOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiNotificationChannelOut](JsonApiNotificationChannelOut.md) | [**JsonApiNotificationChannelOut**](JsonApiNotificationChannelOut.md) | [**JsonApiNotificationChannelOut**](JsonApiNotificationChannelOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiNotificationChannelPatch.md b/gooddata-api-client/docs/models/JsonApiNotificationChannelPatch.md new file mode 100644 index 000000000..d8981d135 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiNotificationChannelPatch.md @@ -0,0 +1,57 @@ +# gooddata_api_client.model.json_api_notification_channel_patch.JsonApiNotificationChannelPatch + +JSON:API representation of patching notificationChannel entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching notificationChannel entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["notificationChannel", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**allowedRecipients** | str, | str, | Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization | [optional] must be one of ["CREATOR", "INTERNAL", "EXTERNAL", ] +**customDashboardUrl** | str, | str, | Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} | [optional] +**dashboardLinkVisibility** | str, | str, | Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link | [optional] must be one of ["HIDDEN", "INTERNAL_ONLY", "ALL", ] +**description** | None, str, | NoneClass, str, | | [optional] +**[destination](#destination)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | The destination where the notifications are to be sent. | [optional] +**inPlatformNotification** | str, | str, | In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications | [optional] must be one of ["DISABLED", "ENABLED", ] +**name** | None, str, | NoneClass, str, | | [optional] +**notificationSource** | str, | str, | Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# destination + +The destination where the notifications are to be sent. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | The destination where the notifications are to be sent. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[DefaultSmtp](DefaultSmtp.md) | [**DefaultSmtp**](DefaultSmtp.md) | [**DefaultSmtp**](DefaultSmtp.md) | | +[InPlatform](InPlatform.md) | [**InPlatform**](InPlatform.md) | [**InPlatform**](InPlatform.md) | | +[Smtp](Smtp.md) | [**Smtp**](Smtp.md) | [**Smtp**](Smtp.md) | | +[Webhook](Webhook.md) | [**Webhook**](Webhook.md) | [**Webhook**](Webhook.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiNotificationChannelPatchDocument.md b/gooddata-api-client/docs/models/JsonApiNotificationChannelPatchDocument.md new file mode 100644 index 000000000..972a6561b --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiNotificationChannelPatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_notification_channel_patch_document.JsonApiNotificationChannelPatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiNotificationChannelPatch**](JsonApiNotificationChannelPatch.md) | [**JsonApiNotificationChannelPatch**](JsonApiNotificationChannelPatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiNotificationChannelPostOptionalId.md b/gooddata-api-client/docs/models/JsonApiNotificationChannelPostOptionalId.md new file mode 100644 index 000000000..4d9c97880 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiNotificationChannelPostOptionalId.md @@ -0,0 +1,57 @@ +# gooddata_api_client.model.json_api_notification_channel_post_optional_id.JsonApiNotificationChannelPostOptionalId + +JSON:API representation of notificationChannel entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of notificationChannel entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**type** | str, | str, | Object type | must be one of ["notificationChannel", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**id** | str, | str, | API identifier of an object | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**allowedRecipients** | str, | str, | Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization | [optional] must be one of ["CREATOR", "INTERNAL", "EXTERNAL", ] +**customDashboardUrl** | str, | str, | Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} | [optional] +**dashboardLinkVisibility** | str, | str, | Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link | [optional] must be one of ["HIDDEN", "INTERNAL_ONLY", "ALL", ] +**description** | None, str, | NoneClass, str, | | [optional] +**[destination](#destination)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | The destination where the notifications are to be sent. | [optional] +**inPlatformNotification** | str, | str, | In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications | [optional] must be one of ["DISABLED", "ENABLED", ] +**name** | None, str, | NoneClass, str, | | [optional] +**notificationSource** | str, | str, | Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}} | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# destination + +The destination where the notifications are to be sent. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | The destination where the notifications are to be sent. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[DefaultSmtp](DefaultSmtp.md) | [**DefaultSmtp**](DefaultSmtp.md) | [**DefaultSmtp**](DefaultSmtp.md) | | +[InPlatform](InPlatform.md) | [**InPlatform**](InPlatform.md) | [**InPlatform**](InPlatform.md) | | +[Smtp](Smtp.md) | [**Smtp**](Smtp.md) | [**Smtp**](Smtp.md) | | +[Webhook](Webhook.md) | [**Webhook**](Webhook.md) | [**Webhook**](Webhook.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiNotificationChannelPostOptionalIdDocument.md b/gooddata-api-client/docs/models/JsonApiNotificationChannelPostOptionalIdDocument.md new file mode 100644 index 000000000..9d26614a7 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiNotificationChannelPostOptionalIdDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_notification_channel_post_optional_id_document.JsonApiNotificationChannelPostOptionalIdDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiNotificationChannelPostOptionalId**](JsonApiNotificationChannelPostOptionalId.md) | [**JsonApiNotificationChannelPostOptionalId**](JsonApiNotificationChannelPostOptionalId.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiNotificationChannelToOneLinkage.md b/gooddata-api-client/docs/models/JsonApiNotificationChannelToOneLinkage.md new file mode 100644 index 000000000..c24ca4b5b --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiNotificationChannelToOneLinkage.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.json_api_notification_channel_to_one_linkage.JsonApiNotificationChannelToOneLinkage + +References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiNotificationChannelLinkage](JsonApiNotificationChannelLinkage.md) | [**JsonApiNotificationChannelLinkage**](JsonApiNotificationChannelLinkage.md) | [**JsonApiNotificationChannelLinkage**](JsonApiNotificationChannelLinkage.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiUserIdentifierLinkage.md b/gooddata-api-client/docs/models/JsonApiUserIdentifierLinkage.md new file mode 100644 index 000000000..902a955b6 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiUserIdentifierLinkage.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.json_api_user_identifier_linkage.JsonApiUserIdentifierLinkage + +The \\\"type\\\" and \\\"id\\\" to non-empty members. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | The \\\"type\\\" and \\\"id\\\" to non-empty members. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**type** | str, | str, | | must be one of ["userIdentifier", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiUserIdentifierOut.md b/gooddata-api-client/docs/models/JsonApiUserIdentifierOut.md new file mode 100644 index 000000000..67ca87b52 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiUserIdentifierOut.md @@ -0,0 +1,34 @@ +# gooddata_api_client.model.json_api_user_identifier_out.JsonApiUserIdentifierOut + +JSON:API representation of userIdentifier entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of userIdentifier entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["userIdentifier", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**email** | str, | str, | | [optional] +**firstname** | str, | str, | | [optional] +**lastname** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiUserIdentifierOutDocument.md b/gooddata-api-client/docs/models/JsonApiUserIdentifierOutDocument.md new file mode 100644 index 000000000..9f6445de3 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiUserIdentifierOutDocument.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_user_identifier_out_document.JsonApiUserIdentifierOutDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserIdentifierOut**](JsonApiUserIdentifierOut.md) | [**JsonApiUserIdentifierOut**](JsonApiUserIdentifierOut.md) | | +**links** | [**ObjectLinks**](ObjectLinks.md) | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiUserIdentifierOutList.md b/gooddata-api-client/docs/models/JsonApiUserIdentifierOutList.md new file mode 100644 index 000000000..2acc38fa5 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiUserIdentifierOutList.md @@ -0,0 +1,44 @@ +# gooddata_api_client.model.json_api_user_identifier_out_list.JsonApiUserIdentifierOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | [**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | [**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiUserIdentifierOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiUserIdentifierOutWithLinks.md new file mode 100644 index 000000000..b81338930 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiUserIdentifierOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_user_identifier_out_with_links.JsonApiUserIdentifierOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiUserIdentifierOut](JsonApiUserIdentifierOut.md) | [**JsonApiUserIdentifierOut**](JsonApiUserIdentifierOut.md) | [**JsonApiUserIdentifierOut**](JsonApiUserIdentifierOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiUserIdentifierToOneLinkage.md b/gooddata-api-client/docs/models/JsonApiUserIdentifierToOneLinkage.md new file mode 100644 index 000000000..a688c1aa8 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiUserIdentifierToOneLinkage.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.json_api_user_identifier_to_one_linkage.JsonApiUserIdentifierToOneLinkage + +References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiUserIdentifierLinkage](JsonApiUserIdentifierLinkage.md) | [**JsonApiUserIdentifierLinkage**](JsonApiUserIdentifierLinkage.md) | [**JsonApiUserIdentifierLinkage**](JsonApiUserIdentifierLinkage.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiUserToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiUserToManyLinkage.md new file mode 100644 index 000000000..7588a9adf --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiUserToManyLinkage.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_user_to_many_linkage.JsonApiUserToManyLinkage + +References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiUserLinkage**](JsonApiUserLinkage.md) | [**JsonApiUserLinkage**](JsonApiUserLinkage.md) | [**JsonApiUserLinkage**](JsonApiUserLinkage.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiVisualizationObjectToOneLinkage.md b/gooddata-api-client/docs/models/JsonApiVisualizationObjectToOneLinkage.md new file mode 100644 index 000000000..6bfa793bc --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiVisualizationObjectToOneLinkage.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.json_api_visualization_object_to_one_linkage.JsonApiVisualizationObjectToOneLinkage + +References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiVisualizationObjectLinkage](JsonApiVisualizationObjectLinkage.md) | [**JsonApiVisualizationObjectLinkage**](JsonApiVisualizationObjectLinkage.md) | [**JsonApiVisualizationObjectLinkage**](JsonApiVisualizationObjectLinkage.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceAutomationOut.md b/gooddata-api-client/docs/models/JsonApiWorkspaceAutomationOut.md new file mode 100644 index 000000000..ceb9847c9 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceAutomationOut.md @@ -0,0 +1,433 @@ +# gooddata_api_client.model.json_api_workspace_automation_out.JsonApiWorkspaceAutomationOut + +JSON:API representation of workspaceAutomation entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of workspaceAutomation entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["workspaceAutomation", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[alert](#alert)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**areRelationsValid** | bool, | BoolClass, | | [optional] +**createdAt** | str, datetime, | str, | | [optional] value must conform to RFC-3339 date-time +**[dashboardTabularExports](#dashboardTabularExports)** | list, tuple, | tuple, | | [optional] +**description** | str, | str, | | [optional] +**[details](#details)** | dict, frozendict.frozendict, | frozendict.frozendict, | Additional details to be included in the automated message. | [optional] +**evaluationMode** | str, | str, | Specify automation evaluation mode. | [optional] must be one of ["SHARED", "PER_RECIPIENT", ] +**[externalRecipients](#externalRecipients)** | list, tuple, | tuple, | External recipients of the automation action results. | [optional] +**[imageExports](#imageExports)** | list, tuple, | tuple, | | [optional] +**[metadata](#metadata)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Additional information for the automation. | [optional] +**modifiedAt** | str, datetime, | str, | | [optional] value must conform to RFC-3339 date-time +**[rawExports](#rawExports)** | list, tuple, | tuple, | | [optional] +**[schedule](#schedule)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[slidesExports](#slidesExports)** | list, tuple, | tuple, | | [optional] +**state** | str, | str, | Current state of the automation. | [optional] must be one of ["ACTIVE", "PAUSED", ] +**[tabularExports](#tabularExports)** | list, tuple, | tuple, | | [optional] +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**[visualExports](#visualExports)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# alert + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**execution** | [**AlertAfm**](AlertAfm.md) | [**AlertAfm**](AlertAfm.md) | | +**condition** | [**AlertCondition**](AlertCondition.md) | [**AlertCondition**](AlertCondition.md) | | +**interval** | str, | str, | Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR. | [optional] must be one of ["DAY", "WEEK", "MONTH", "QUARTER", "YEAR", ] +**trigger** | str, | 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] must be one of ["ALWAYS", "ONCE", "ONCE_PER_INTERVAL", ] if omitted the server will use the default value of "ALWAYS" +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dashboardTabularExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**DashboardTabularExportRequestV2**](DashboardTabularExportRequestV2.md) | [**DashboardTabularExportRequestV2**](DashboardTabularExportRequestV2.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# details + +Additional details to be included in the automated message. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Additional details to be included in the automated message. | + +# externalRecipients + +External recipients of the automation action results. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | External recipients of the automation action results. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**email** | str, | str, | E-mail address to send notifications from. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# imageExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**ImageExportRequest**](ImageExportRequest.md) | [**ImageExportRequest**](ImageExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# metadata + +Additional information for the automation. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Additional information for the automation. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[visibleFilters](#visibleFilters)** | list, tuple, | tuple, | | [optional] +**widget** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# visibleFilters + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**VisibleFilter**](VisibleFilter.md) | [**VisibleFilter**](VisibleFilter.md) | [**VisibleFilter**](VisibleFilter.md) | | + +# rawExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**RawExportAutomationRequest**](RawExportAutomationRequest.md) | [**RawExportAutomationRequest**](RawExportAutomationRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# schedule + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**cron** | str, | str, | 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. | +**timezone** | str, | str, | Timezone in which the schedule is defined. | +**cronDescription** | str, | str, | Human-readable description of the cron expression. | [optional] +**firstRun** | str, datetime, | str, | Timestamp of the first scheduled action. If not provided default to the next scheduled time. | [optional] value must conform to RFC-3339 date-time +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# slidesExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**SlidesExportRequest**](SlidesExportRequest.md) | [**SlidesExportRequest**](SlidesExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tabularExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**TabularExportRequest**](TabularExportRequest.md) | [**TabularExportRequest**](TabularExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# visualExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requestPayload** | [**VisualExportRequest**](VisualExportRequest.md) | [**VisualExportRequest**](VisualExportRequest.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[analyticalDashboard](#analyticalDashboard)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[automationResults](#automationResults)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[createdBy](#createdBy)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[exportDefinitions](#exportDefinitions)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[modifiedBy](#modifiedBy)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[notificationChannel](#notificationChannel)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[recipients](#recipients)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[workspace](#workspace)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# analyticalDashboard + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | [**JsonApiAnalyticalDashboardToOneLinkage**](JsonApiAnalyticalDashboardToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# automationResults + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiAutomationResultToManyLinkage**](JsonApiAutomationResultToManyLinkage.md) | [**JsonApiAutomationResultToManyLinkage**](JsonApiAutomationResultToManyLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# createdBy + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# exportDefinitions + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiExportDefinitionToManyLinkage**](JsonApiExportDefinitionToManyLinkage.md) | [**JsonApiExportDefinitionToManyLinkage**](JsonApiExportDefinitionToManyLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# modifiedBy + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | [**JsonApiUserIdentifierToOneLinkage**](JsonApiUserIdentifierToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# notificationChannel + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiNotificationChannelToOneLinkage**](JsonApiNotificationChannelToOneLinkage.md) | [**JsonApiNotificationChannelToOneLinkage**](JsonApiNotificationChannelToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# recipients + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiUserToManyLinkage**](JsonApiUserToManyLinkage.md) | [**JsonApiUserToManyLinkage**](JsonApiUserToManyLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# workspace + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiWorkspaceToOneLinkage**](JsonApiWorkspaceToOneLinkage.md) | [**JsonApiWorkspaceToOneLinkage**](JsonApiWorkspaceToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceAutomationOutIncludes.md b/gooddata-api-client/docs/models/JsonApiWorkspaceAutomationOutIncludes.md new file mode 100644 index 000000000..578edf225 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceAutomationOutIncludes.md @@ -0,0 +1,21 @@ +# gooddata_api_client.model.json_api_workspace_automation_out_includes.JsonApiWorkspaceAutomationOutIncludes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiWorkspaceOutWithLinks](JsonApiWorkspaceOutWithLinks.md) | [**JsonApiWorkspaceOutWithLinks**](JsonApiWorkspaceOutWithLinks.md) | [**JsonApiWorkspaceOutWithLinks**](JsonApiWorkspaceOutWithLinks.md) | | +[JsonApiNotificationChannelOutWithLinks](JsonApiNotificationChannelOutWithLinks.md) | [**JsonApiNotificationChannelOutWithLinks**](JsonApiNotificationChannelOutWithLinks.md) | [**JsonApiNotificationChannelOutWithLinks**](JsonApiNotificationChannelOutWithLinks.md) | | +[JsonApiAnalyticalDashboardOutWithLinks](JsonApiAnalyticalDashboardOutWithLinks.md) | [**JsonApiAnalyticalDashboardOutWithLinks**](JsonApiAnalyticalDashboardOutWithLinks.md) | [**JsonApiAnalyticalDashboardOutWithLinks**](JsonApiAnalyticalDashboardOutWithLinks.md) | | +[JsonApiUserIdentifierOutWithLinks](JsonApiUserIdentifierOutWithLinks.md) | [**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | [**JsonApiUserIdentifierOutWithLinks**](JsonApiUserIdentifierOutWithLinks.md) | | +[JsonApiExportDefinitionOutWithLinks](JsonApiExportDefinitionOutWithLinks.md) | [**JsonApiExportDefinitionOutWithLinks**](JsonApiExportDefinitionOutWithLinks.md) | [**JsonApiExportDefinitionOutWithLinks**](JsonApiExportDefinitionOutWithLinks.md) | | +[JsonApiUserOutWithLinks](JsonApiUserOutWithLinks.md) | [**JsonApiUserOutWithLinks**](JsonApiUserOutWithLinks.md) | [**JsonApiUserOutWithLinks**](JsonApiUserOutWithLinks.md) | | +[JsonApiAutomationResultOutWithLinks](JsonApiAutomationResultOutWithLinks.md) | [**JsonApiAutomationResultOutWithLinks**](JsonApiAutomationResultOutWithLinks.md) | [**JsonApiAutomationResultOutWithLinks**](JsonApiAutomationResultOutWithLinks.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceAutomationOutList.md b/gooddata-api-client/docs/models/JsonApiWorkspaceAutomationOutList.md new file mode 100644 index 000000000..fd091517f --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceAutomationOutList.md @@ -0,0 +1,59 @@ +# gooddata_api_client.model.json_api_workspace_automation_out_list.JsonApiWorkspaceAutomationOutList + +A JSON:API document with a list of resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A JSON:API document with a list of resources | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**[included](#included)** | list, tuple, | tuple, | Included resources | [optional] +**links** | [**ListLinks**](ListLinks.md) | [**ListLinks**](ListLinks.md) | | [optional] +**[meta](#meta)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiWorkspaceAutomationOutWithLinks**](JsonApiWorkspaceAutomationOutWithLinks.md) | [**JsonApiWorkspaceAutomationOutWithLinks**](JsonApiWorkspaceAutomationOutWithLinks.md) | [**JsonApiWorkspaceAutomationOutWithLinks**](JsonApiWorkspaceAutomationOutWithLinks.md) | | + +# included + +Included resources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Included resources | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiWorkspaceAutomationOutIncludes**](JsonApiWorkspaceAutomationOutIncludes.md) | [**JsonApiWorkspaceAutomationOutIncludes**](JsonApiWorkspaceAutomationOutIncludes.md) | [**JsonApiWorkspaceAutomationOutIncludes**](JsonApiWorkspaceAutomationOutIncludes.md) | | + +# meta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.md) | [**PageMetadata**](PageMetadata.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceAutomationOutWithLinks.md b/gooddata-api-client/docs/models/JsonApiWorkspaceAutomationOutWithLinks.md new file mode 100644 index 000000000..e597ff5fe --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceAutomationOutWithLinks.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_workspace_automation_out_with_links.JsonApiWorkspaceAutomationOutWithLinks + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[JsonApiWorkspaceAutomationOut](JsonApiWorkspaceAutomationOut.md) | [**JsonApiWorkspaceAutomationOut**](JsonApiWorkspaceAutomationOut.md) | [**JsonApiWorkspaceAutomationOut**](JsonApiWorkspaceAutomationOut.md) | | +[ObjectLinksContainer](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | [**ObjectLinksContainer**](ObjectLinksContainer.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingIn.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingIn.md new file mode 100644 index 000000000..2b1bfef63 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingIn.md @@ -0,0 +1,73 @@ +# gooddata_api_client.model.json_api_workspace_data_filter_setting_in.JsonApiWorkspaceDataFilterSettingIn + +JSON:API representation of workspaceDataFilterSetting entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of workspaceDataFilterSetting entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["workspaceDataFilterSetting", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**description** | str, | str, | | [optional] +**[filterValues](#filterValues)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# filterValues + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[workspaceDataFilter](#workspaceDataFilter)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# workspaceDataFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiWorkspaceDataFilterToOneLinkage**](JsonApiWorkspaceDataFilterToOneLinkage.md) | [**JsonApiWorkspaceDataFilterToOneLinkage**](JsonApiWorkspaceDataFilterToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingInDocument.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingInDocument.md new file mode 100644 index 000000000..cec14e662 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingInDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document.JsonApiWorkspaceDataFilterSettingInDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiWorkspaceDataFilterSettingIn**](JsonApiWorkspaceDataFilterSettingIn.md) | [**JsonApiWorkspaceDataFilterSettingIn**](JsonApiWorkspaceDataFilterSettingIn.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingPatch.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingPatch.md new file mode 100644 index 000000000..2928af2fb --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingPatch.md @@ -0,0 +1,73 @@ +# gooddata_api_client.model.json_api_workspace_data_filter_setting_patch.JsonApiWorkspaceDataFilterSettingPatch + +JSON:API representation of patching workspaceDataFilterSetting entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | JSON:API representation of patching workspaceDataFilterSetting entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | API identifier of an object | +**type** | str, | str, | Object type | must be one of ["workspaceDataFilterSetting", ] +**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[relationships](#relationships)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**description** | str, | str, | | [optional] +**[filterValues](#filterValues)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# filterValues + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[workspaceDataFilter](#workspaceDataFilter)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# workspaceDataFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiWorkspaceDataFilterToOneLinkage**](JsonApiWorkspaceDataFilterToOneLinkage.md) | [**JsonApiWorkspaceDataFilterToOneLinkage**](JsonApiWorkspaceDataFilterToOneLinkage.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingPatchDocument.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingPatchDocument.md new file mode 100644 index 000000000..1bf4ae980 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterSettingPatchDocument.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.json_api_workspace_data_filter_setting_patch_document.JsonApiWorkspaceDataFilterSettingPatchDocument + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**JsonApiWorkspaceDataFilterSettingPatch**](JsonApiWorkspaceDataFilterSettingPatch.md) | [**JsonApiWorkspaceDataFilterSettingPatch**](JsonApiWorkspaceDataFilterSettingPatch.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterToManyLinkage.md b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterToManyLinkage.md new file mode 100644 index 000000000..14b81e583 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonApiWorkspaceDataFilterToManyLinkage.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.json_api_workspace_data_filter_to_many_linkage.JsonApiWorkspaceDataFilterToManyLinkage + +References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**JsonApiWorkspaceDataFilterLinkage**](JsonApiWorkspaceDataFilterLinkage.md) | [**JsonApiWorkspaceDataFilterLinkage**](JsonApiWorkspaceDataFilterLinkage.md) | [**JsonApiWorkspaceDataFilterLinkage**](JsonApiWorkspaceDataFilterLinkage.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/JsonNode.md b/gooddata-api-client/docs/models/JsonNode.md new file mode 100644 index 000000000..a7a415bf5 --- /dev/null +++ b/gooddata-api-client/docs/models/JsonNode.md @@ -0,0 +1,11 @@ +# gooddata_api_client.model.json_node.JsonNode + +Free-form JSON object + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Free-form JSON 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/models/KeyDriversDimension.md b/gooddata-api-client/docs/models/KeyDriversDimension.md new file mode 100644 index 000000000..43e85088c --- /dev/null +++ b/gooddata-api-client/docs/models/KeyDriversDimension.md @@ -0,0 +1,21 @@ +# gooddata_api_client.model.key_drivers_dimension.KeyDriversDimension + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**attributeName** | str, | str, | | +**attribute** | [**RestApiIdentifier**](RestApiIdentifier.md) | [**RestApiIdentifier**](RestApiIdentifier.md) | | +**label** | [**RestApiIdentifier**](RestApiIdentifier.md) | [**RestApiIdentifier**](RestApiIdentifier.md) | | +**labelName** | str, | str, | | +**format** | [**AttributeFormat**](AttributeFormat.md) | [**AttributeFormat**](AttributeFormat.md) | | [optional] +**granularity** | str, | str, | | [optional] must be one of ["MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR", ] +**valueType** | str, | str, | | [optional] must be one of ["TEXT", "HYPERLINK", "GEO", "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", "IMAGE", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/KeyDriversRequest.md b/gooddata-api-client/docs/models/KeyDriversRequest.md new file mode 100644 index 000000000..36f404d6f --- /dev/null +++ b/gooddata-api-client/docs/models/KeyDriversRequest.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.key_drivers_request.KeyDriversRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**metric** | [**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | | +**[auxMetrics](#auxMetrics)** | list, tuple, | tuple, | Additional metrics to be included in the computation, but excluded from the analysis. | [optional] +**sortDirection** | str, | str, | Sorting elements - ascending/descending order. | [optional] must be one of ["ASC", "DESC", ] if omitted the server will use the default value of "DESC" +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# auxMetrics + +Additional metrics to be included in the computation, but excluded from the analysis. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Additional metrics to be included in the computation, but excluded from the analysis. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/KeyDriversResponse.md b/gooddata-api-client/docs/models/KeyDriversResponse.md new file mode 100644 index 000000000..44ed4c99c --- /dev/null +++ b/gooddata-api-client/docs/models/KeyDriversResponse.md @@ -0,0 +1,28 @@ +# gooddata_api_client.model.key_drivers_response.KeyDriversResponse + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**links** | [**ExecutionLinks**](ExecutionLinks.md) | [**ExecutionLinks**](ExecutionLinks.md) | | +**[dimensions](#dimensions)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dimensions + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**KeyDriversDimension**](KeyDriversDimension.md) | [**KeyDriversDimension**](KeyDriversDimension.md) | [**KeyDriversDimension**](KeyDriversDimension.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/KeyDriversResult.md b/gooddata-api-client/docs/models/KeyDriversResult.md new file mode 100644 index 000000000..d1e7b1d67 --- /dev/null +++ b/gooddata-api-client/docs/models/KeyDriversResult.md @@ -0,0 +1,22 @@ +# gooddata_api_client.model.key_drivers_result.KeyDriversResult + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/KnowledgeDocumentMetadataDto.md b/gooddata-api-client/docs/models/KnowledgeDocumentMetadataDto.md new file mode 100644 index 000000000..2b90b866c --- /dev/null +++ b/gooddata-api-client/docs/models/KnowledgeDocumentMetadataDto.md @@ -0,0 +1,36 @@ +# gooddata_api_client.model.knowledge_document_metadata_dto.KnowledgeDocumentMetadataDto + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**createdAt** | str, | str, | | +**numChunks** | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer +**filename** | str, | str, | | +**updatedBy** | str, | str, | | +**createdBy** | str, | str, | | +**[scopes](#scopes)** | list, tuple, | tuple, | | +**updatedAt** | str, | str, | | +**isDisabled** | bool, | BoolClass, | | [optional] +**title** | str, | str, | | [optional] +**workspaceId** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# scopes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/KnowledgeSearchResultDto.md b/gooddata-api-client/docs/models/KnowledgeSearchResultDto.md new file mode 100644 index 000000000..f67a1ecbb --- /dev/null +++ b/gooddata-api-client/docs/models/KnowledgeSearchResultDto.md @@ -0,0 +1,47 @@ +# gooddata_api_client.model.knowledge_search_result_dto.KnowledgeSearchResultDto + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**score** | decimal.Decimal, int, float, | decimal.Decimal, | | value must be a 32 bit float +**filename** | str, | str, | | +**[pageNumbers](#pageNumbers)** | list, tuple, | tuple, | | +**totalChunks** | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer +**[scopes](#scopes)** | list, tuple, | tuple, | | +**chunkIndex** | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer +**content** | str, | str, | | +**title** | str, | str, | | [optional] +**workspaceId** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# pageNumbers + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +# scopes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ListKnowledgeDocumentsResponseDto.md b/gooddata-api-client/docs/models/ListKnowledgeDocumentsResponseDto.md new file mode 100644 index 000000000..bddc77a82 --- /dev/null +++ b/gooddata-api-client/docs/models/ListKnowledgeDocumentsResponseDto.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.list_knowledge_documents_response_dto.ListKnowledgeDocumentsResponseDto + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[documents](#documents)** | list, tuple, | tuple, | | +**nextPageToken** | str, | str, | | [optional] +**totalCount** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# documents + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**KnowledgeDocumentMetadataDto**](KnowledgeDocumentMetadataDto.md) | [**KnowledgeDocumentMetadataDto**](KnowledgeDocumentMetadataDto.md) | [**KnowledgeDocumentMetadataDto**](KnowledgeDocumentMetadataDto.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/LlmModel.md b/gooddata-api-client/docs/models/LlmModel.md new file mode 100644 index 000000000..6dc422e2c --- /dev/null +++ b/gooddata-api-client/docs/models/LlmModel.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.llm_model.LlmModel + +LLM Model configuration (id, family) within a provider. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | LLM Model configuration (id, family) within a provider. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Unique identifier of the model (e.g., gpt-5.3, claude-4.6). | +**family** | str, | str, | Family of LLM models. | must be one of ["OPENAI", "ANTHROPIC", "META", "MISTRAL", "AMAZON", "GOOGLE", "COHERE", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/LlmProviderAuth.md b/gooddata-api-client/docs/models/LlmProviderAuth.md new file mode 100644 index 000000000..124631624 --- /dev/null +++ b/gooddata-api-client/docs/models/LlmProviderAuth.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.llm_provider_auth.LlmProviderAuth + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**type** | str, | str, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/LlmProviderConfig.md b/gooddata-api-client/docs/models/LlmProviderConfig.md new file mode 100644 index 000000000..891534bef --- /dev/null +++ b/gooddata-api-client/docs/models/LlmProviderConfig.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.llm_provider_config.LlmProviderConfig + +Provider configuration to test. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Provider configuration to test. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AwsBedrockProviderConfig](AwsBedrockProviderConfig.md) | [**AwsBedrockProviderConfig**](AwsBedrockProviderConfig.md) | [**AwsBedrockProviderConfig**](AwsBedrockProviderConfig.md) | | +[AzureFoundryProviderConfig](AzureFoundryProviderConfig.md) | [**AzureFoundryProviderConfig**](AzureFoundryProviderConfig.md) | [**AzureFoundryProviderConfig**](AzureFoundryProviderConfig.md) | | +[OpenAIProviderConfig](OpenAIProviderConfig.md) | [**OpenAIProviderConfig**](OpenAIProviderConfig.md) | [**OpenAIProviderConfig**](OpenAIProviderConfig.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/LocalIdentifier.md b/gooddata-api-client/docs/models/LocalIdentifier.md new file mode 100644 index 000000000..75c76f507 --- /dev/null +++ b/gooddata-api-client/docs/models/LocalIdentifier.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.local_identifier.LocalIdentifier + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**localIdentifier** | str, | str, | Local identifier of the metric to be compared. | +**format** | None, str, | NoneClass, str, | Metric format. | [optional] if omitted the server will use the default value of "#,##0.00" +**title** | None, str, | NoneClass, str, | Metric title. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/LocaleRequest.md b/gooddata-api-client/docs/models/LocaleRequest.md new file mode 100644 index 000000000..76e4d3318 --- /dev/null +++ b/gooddata-api-client/docs/models/LocaleRequest.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.locale_request.LocaleRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**locale** | str, | str, | Requested locale in the form of language tag (see RFC 5646). | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/MatchAttributeFilter.md b/gooddata-api-client/docs/models/MatchAttributeFilter.md new file mode 100644 index 000000000..f74ca6259 --- /dev/null +++ b/gooddata-api-client/docs/models/MatchAttributeFilter.md @@ -0,0 +1,36 @@ +# gooddata_api_client.model.match_attribute_filter.MatchAttributeFilter + +Filter via label with given match type and literal value. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Filter via label with given match type and literal value. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[matchAttributeFilter](#matchAttributeFilter)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# matchAttributeFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**matchType** | str, | str, | Requested match type. | must be one of ["STARTS_WITH", "ENDS_WITH", "CONTAINS", ] +**label** | [**AfmIdentifier**](AfmIdentifier.md) | [**AfmIdentifier**](AfmIdentifier.md) | | +**literal** | str, | str, | Literal used to limit label values. | +**applyOnResult** | bool, | BoolClass, | | [optional] +**caseSensitive** | bool, | BoolClass, | Indicates whether the filter match is evaluated in case-sensitive mode or not. | [optional] if omitted the server will use the default value of False +**localIdentifier** | str, | str, | | [optional] +**negate** | bool, | BoolClass, | Indicates whether the filter should negate the match. | [optional] if omitted the server will use the default value of False +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/MeasureHeader.md b/gooddata-api-client/docs/models/MeasureHeader.md new file mode 100644 index 000000000..5bdde921e --- /dev/null +++ b/gooddata-api-client/docs/models/MeasureHeader.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.measure_header.MeasureHeader + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**localIdentifier** | str, | str, | Local identifier of the measure this header relates to. | +**format** | str, | str, | Format to be used to format the measure data. | [optional] +**name** | str, | str, | Name of the measure. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/MeasureValueCondition.md b/gooddata-api-client/docs/models/MeasureValueCondition.md new file mode 100644 index 000000000..3fefe4398 --- /dev/null +++ b/gooddata-api-client/docs/models/MeasureValueCondition.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.measure_value_condition.MeasureValueCondition + +A condition for filtering by measure value. Can be either a comparison or a range condition. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A condition for filtering by measure value. Can be either a comparison or a range condition. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[ComparisonCondition](ComparisonCondition.md) | [**ComparisonCondition**](ComparisonCondition.md) | [**ComparisonCondition**](ComparisonCondition.md) | | +[RangeCondition](RangeCondition.md) | [**RangeCondition**](RangeCondition.md) | [**RangeCondition**](RangeCondition.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/MemoryItemCreatedByUsers.md b/gooddata-api-client/docs/models/MemoryItemCreatedByUsers.md new file mode 100644 index 000000000..70e312b67 --- /dev/null +++ b/gooddata-api-client/docs/models/MemoryItemCreatedByUsers.md @@ -0,0 +1,30 @@ +# gooddata_api_client.model.memory_item_created_by_users.MemoryItemCreatedByUsers + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**reasoning** | str, | str, | Reasoning for error states | +**[users](#users)** | list, tuple, | tuple, | Users who created memory item | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# users + +Users who created memory item + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Users who created memory item | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**MemoryItemUser**](MemoryItemUser.md) | [**MemoryItemUser**](MemoryItemUser.md) | [**MemoryItemUser**](MemoryItemUser.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/MemoryItemUser.md b/gooddata-api-client/docs/models/MemoryItemUser.md new file mode 100644 index 000000000..0d96138fd --- /dev/null +++ b/gooddata-api-client/docs/models/MemoryItemUser.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.memory_item_user.MemoryItemUser + +Users who created memory item + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Users who created memory item | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**firstname** | str, | str, | First name of the user who created memory item | +**userId** | str, | str, | User ID of the user who created memory item | +**lastname** | str, | str, | Last name of the user who created memory item | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Metric.md b/gooddata-api-client/docs/models/Metric.md new file mode 100644 index 000000000..f73979780 --- /dev/null +++ b/gooddata-api-client/docs/models/Metric.md @@ -0,0 +1,20 @@ +# gooddata_api_client.model.metric.Metric + +List of metrics to be used in the new visualization + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | List of metrics to be used in the new visualization | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | ID of the object | +**title** | str, | str, | Title of metric. | +**type** | str, | str, | Object type | must be one of ["metric", "fact", "attribute", ] +**aggFunction** | str, | str, | Agg function. Empty if a stored metric is used. | [optional] must be one of ["COUNT", "SUM", "MIN", "MAX", "AVG", "MEDIAN", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/MetricDefinitionOverride.md b/gooddata-api-client/docs/models/MetricDefinitionOverride.md new file mode 100644 index 000000000..910c86a12 --- /dev/null +++ b/gooddata-api-client/docs/models/MetricDefinitionOverride.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.metric_definition_override.MetricDefinitionOverride + +(EXPERIMENTAL) Override for a catalog metric definition. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | (EXPERIMENTAL) Override for a catalog metric definition. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**item** | [**AfmObjectIdentifierCore**](AfmObjectIdentifierCore.md) | [**AfmObjectIdentifierCore**](AfmObjectIdentifierCore.md) | | +**definition** | [**InlineMeasureDefinition**](InlineMeasureDefinition.md) | [**InlineMeasureDefinition**](InlineMeasureDefinition.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/MetricRecord.md b/gooddata-api-client/docs/models/MetricRecord.md new file mode 100644 index 000000000..f417ef303 --- /dev/null +++ b/gooddata-api-client/docs/models/MetricRecord.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.metric_record.MetricRecord + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**value** | decimal.Decimal, int, float, | decimal.Decimal, | | value must be a 64 bit float +**formattedValue** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/MetricValueChange.md b/gooddata-api-client/docs/models/MetricValueChange.md new file mode 100644 index 000000000..2b41618fb --- /dev/null +++ b/gooddata-api-client/docs/models/MetricValueChange.md @@ -0,0 +1,27 @@ +# gooddata_api_client.model.metric_value_change.MetricValueChange + +Individual change analysis data item + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Individual change analysis data item | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**overallMetricValueInReferencePeriod** | decimal.Decimal, int, float, | decimal.Decimal, | The overall metric value in the reference period | value must be a 64 bit float +**metricValueDeltaAbs** | decimal.Decimal, int, float, | decimal.Decimal, | The absolute delta between analyzed and reference periods | value must be a 64 bit float +**isSignificantChange** | bool, | BoolClass, | Whether the change is statistically significant | +**attributeValue** | str, | str, | The value of the attribute being analyzed | +**attributeValuesChangeStd** | decimal.Decimal, int, float, | decimal.Decimal, | The standard deviation of attribute value changes for the attribute being analyzed | value must be a 64 bit float +**attributeName** | str, | str, | The name of the attribute being analyzed | +**metricValueInAnalyzedPeriod** | decimal.Decimal, int, float, | decimal.Decimal, | The metric value in the analyzed period | value must be a 64 bit float +**metricValueDelta** | decimal.Decimal, int, float, | decimal.Decimal, | The delta between analyzed and reference periods | value must be a 64 bit float +**metricValueInReferencePeriod** | decimal.Decimal, int, float, | decimal.Decimal, | The metric value in the reference period | value must be a 64 bit float +**attributeValuesChangeMean** | decimal.Decimal, int, float, | decimal.Decimal, | The mean of attribute value changes for the attribute being analyzed | value must be a 64 bit float +**overallMetricValueInAnalyzedPeriod** | decimal.Decimal, int, float, | decimal.Decimal, | The overall metric value in the analyzed period | value must be a 64 bit float +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ModelTestResult.md b/gooddata-api-client/docs/models/ModelTestResult.md new file mode 100644 index 000000000..07e19c833 --- /dev/null +++ b/gooddata-api-client/docs/models/ModelTestResult.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.model_test_result.ModelTestResult + +Per-model test results. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Per-model test results. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**modelId** | str, | str, | The model ID that was tested. | +**message** | str, | str, | Message about the model test result. | +**successful** | bool, | BoolClass, | Whether the model test was successful. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Note.md b/gooddata-api-client/docs/models/Note.md new file mode 100644 index 000000000..f21f17a71 --- /dev/null +++ b/gooddata-api-client/docs/models/Note.md @@ -0,0 +1,32 @@ +# gooddata_api_client.model.note.Note + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**appliesTo** | str, | str, | | [optional] must be one of ["SOURCE", "TARGET", ] +**category** | str, | str, | | [optional] +**content** | str, | str, | | [optional] +**id** | str, | str, | | [optional] +**[otherAttributes](#otherAttributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**priority** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# otherAttributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Notes.md b/gooddata-api-client/docs/models/Notes.md new file mode 100644 index 000000000..d6995f22e --- /dev/null +++ b/gooddata-api-client/docs/models/Notes.md @@ -0,0 +1,27 @@ +# gooddata_api_client.model.notes.Notes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[note](#note)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# note + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**Note**](Note.md) | [**Note**](Note.md) | [**Note**](Note.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Notification.md b/gooddata-api-client/docs/models/Notification.md new file mode 100644 index 000000000..4805ac477 --- /dev/null +++ b/gooddata-api-client/docs/models/Notification.md @@ -0,0 +1,34 @@ +# gooddata_api_client.model.notification.Notification + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**createdAt** | str, datetime, | str, | | value must conform to RFC-3339 date-time +**[data](#data)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +**isRead** | bool, | BoolClass, | | +**id** | str, | str, | | +**automationId** | str, | str, | | [optional] +**workspaceId** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AutomationNotification](AutomationNotification.md) | [**AutomationNotification**](AutomationNotification.md) | [**AutomationNotification**](AutomationNotification.md) | | +[TestNotification](TestNotification.md) | [**TestNotification**](TestNotification.md) | [**TestNotification**](TestNotification.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/NotificationChannelDestination.md b/gooddata-api-client/docs/models/NotificationChannelDestination.md new file mode 100644 index 000000000..ca93ab53b --- /dev/null +++ b/gooddata-api-client/docs/models/NotificationChannelDestination.md @@ -0,0 +1,24 @@ +# gooddata_api_client.model.notification_channel_destination.NotificationChannelDestination + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**type** | str, | str, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[Webhook](Webhook.md) | [**Webhook**](Webhook.md) | [**Webhook**](Webhook.md) | | +[Smtp](Smtp.md) | [**Smtp**](Smtp.md) | [**Smtp**](Smtp.md) | | +[DefaultSmtp](DefaultSmtp.md) | [**DefaultSmtp**](DefaultSmtp.md) | [**DefaultSmtp**](DefaultSmtp.md) | | +[InPlatform](InPlatform.md) | [**InPlatform**](InPlatform.md) | [**InPlatform**](InPlatform.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/NotificationContent.md b/gooddata-api-client/docs/models/NotificationContent.md new file mode 100644 index 000000000..806dc4f40 --- /dev/null +++ b/gooddata-api-client/docs/models/NotificationContent.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.notification_content.NotificationContent + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**type** | str, | str, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/NotificationFilter.md b/gooddata-api-client/docs/models/NotificationFilter.md new file mode 100644 index 000000000..0ab0b9095 --- /dev/null +++ b/gooddata-api-client/docs/models/NotificationFilter.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.notification_filter.NotificationFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**filter** | str, | str, | | +**title** | str, | str, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Notifications.md b/gooddata-api-client/docs/models/Notifications.md new file mode 100644 index 000000000..d13d99e77 --- /dev/null +++ b/gooddata-api-client/docs/models/Notifications.md @@ -0,0 +1,28 @@ +# gooddata_api_client.model.notifications.Notifications + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**meta** | [**NotificationsMeta**](NotificationsMeta.md) | [**NotificationsMeta**](NotificationsMeta.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**Notification**](Notification.md) | [**Notification**](Notification.md) | [**Notification**](Notification.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/NotificationsMeta.md b/gooddata-api-client/docs/models/NotificationsMeta.md new file mode 100644 index 000000000..841636603 --- /dev/null +++ b/gooddata-api-client/docs/models/NotificationsMeta.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.notifications_meta.NotificationsMeta + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**total** | [**NotificationsMetaTotal**](NotificationsMetaTotal.md) | [**NotificationsMetaTotal**](NotificationsMetaTotal.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/NotificationsMetaTotal.md b/gooddata-api-client/docs/models/NotificationsMetaTotal.md new file mode 100644 index 000000000..9b182c4c4 --- /dev/null +++ b/gooddata-api-client/docs/models/NotificationsMetaTotal.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.notifications_meta_total.NotificationsMetaTotal + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**all** | decimal.Decimal, int, | decimal.Decimal, | | value must be a 64 bit integer +**unread** | decimal.Decimal, int, | decimal.Decimal, | | value must be a 64 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/OpenAIProviderConfig.md b/gooddata-api-client/docs/models/OpenAIProviderConfig.md new file mode 100644 index 000000000..05a96390a --- /dev/null +++ b/gooddata-api-client/docs/models/OpenAIProviderConfig.md @@ -0,0 +1,20 @@ +# gooddata_api_client.model.open_ai_provider_config.OpenAIProviderConfig + +Configuration for OpenAI provider. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Configuration for OpenAI provider. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**auth** | [**OpenAiProviderAuth**](OpenAiProviderAuth.md) | [**OpenAiProviderAuth**](OpenAiProviderAuth.md) | | +**type** | str, | str, | Provider type. | must be one of ["OPENAI", ] +**baseUrl** | None, str, | NoneClass, str, | Custom base URL for OpenAI API. | [optional] if omitted the server will use the default value of "https://api.openai.com" +**organization** | None, str, | NoneClass, str, | OpenAI organization ID. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/OpenAiApiKeyAuth.md b/gooddata-api-client/docs/models/OpenAiApiKeyAuth.md new file mode 100644 index 000000000..535e39ea0 --- /dev/null +++ b/gooddata-api-client/docs/models/OpenAiApiKeyAuth.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.open_ai_api_key_auth.OpenAiApiKeyAuth + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**apiKey** | None, str, | NoneClass, str, | OpenAI API key. | [optional] +**type** | str, | str, | Authentication type. | [optional] must be one of ["API_KEY", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/OpenAiProviderAuth.md b/gooddata-api-client/docs/models/OpenAiProviderAuth.md new file mode 100644 index 000000000..d610f0030 --- /dev/null +++ b/gooddata-api-client/docs/models/OpenAiProviderAuth.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.open_ai_provider_auth.OpenAiProviderAuth + +Authentication configuration. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Authentication configuration. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[OpenAiApiKeyAuth](OpenAiApiKeyAuth.md) | [**OpenAiApiKeyAuth**](OpenAiApiKeyAuth.md) | [**OpenAiApiKeyAuth**](OpenAiApiKeyAuth.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Operation.md b/gooddata-api-client/docs/models/Operation.md new file mode 100644 index 000000000..413e2c3aa --- /dev/null +++ b/gooddata-api-client/docs/models/Operation.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.operation.Operation + +Represents a Long-Running Operation: a process that takes some time to complete. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Represents a Long-Running Operation: a process that takes some time to complete. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**kind** | str, | 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. | must be one of ["provision-database", "deprovision-database", "run-service-command", ] +**id** | str, | str, | Id of the operation | +**status** | str, | str, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/OperationError.md b/gooddata-api-client/docs/models/OperationError.md new file mode 100644 index 000000000..c6ceb63ba --- /dev/null +++ b/gooddata-api-client/docs/models/OperationError.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.operation_error.OperationError + +Error information for a failed operation + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Error information for a failed operation | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**detail** | str, | str, | Human-readable error details | +**title** | str, | str, | Human-readable error name | +**status** | decimal.Decimal, int, | decimal.Decimal, | HTTP status code | value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/OrganizationAutomationIdentifier.md b/gooddata-api-client/docs/models/OrganizationAutomationIdentifier.md new file mode 100644 index 000000000..2da06c22e --- /dev/null +++ b/gooddata-api-client/docs/models/OrganizationAutomationIdentifier.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.organization_automation_identifier.OrganizationAutomationIdentifier + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**workspaceId** | str, | str, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/OrganizationAutomationManagementBulkRequest.md b/gooddata-api-client/docs/models/OrganizationAutomationManagementBulkRequest.md new file mode 100644 index 000000000..b1a0b60e5 --- /dev/null +++ b/gooddata-api-client/docs/models/OrganizationAutomationManagementBulkRequest.md @@ -0,0 +1,27 @@ +# gooddata_api_client.model.organization_automation_management_bulk_request.OrganizationAutomationManagementBulkRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[automations](#automations)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# automations + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**OrganizationAutomationIdentifier**](OrganizationAutomationIdentifier.md) | [**OrganizationAutomationIdentifier**](OrganizationAutomationIdentifier.md) | [**OrganizationAutomationIdentifier**](OrganizationAutomationIdentifier.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/OrganizationPermissionAssignment.md b/gooddata-api-client/docs/models/OrganizationPermissionAssignment.md new file mode 100644 index 000000000..1e034ddc4 --- /dev/null +++ b/gooddata-api-client/docs/models/OrganizationPermissionAssignment.md @@ -0,0 +1,30 @@ +# gooddata_api_client.model.organization_permission_assignment.OrganizationPermissionAssignment + +Organization permission assignments + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Organization permission assignments | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**assigneeIdentifier** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | +**[permissions](#permissions)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# permissions + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["MANAGE", "SELF_CREATE_TOKEN", "BASE_UI_ACCESS", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/OutlierDetectionRequest.md b/gooddata-api-client/docs/models/OutlierDetectionRequest.md new file mode 100644 index 000000000..3eb55277d --- /dev/null +++ b/gooddata-api-client/docs/models/OutlierDetectionRequest.md @@ -0,0 +1,89 @@ +# gooddata_api_client.model.outlier_detection_request.OutlierDetectionRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[measures](#measures)** | list, tuple, | tuple, | | +**granularity** | str, | str, | Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR). | must be one of ["HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", ] +**[attributes](#attributes)** | list, tuple, | tuple, | Attributes to be used in the computation. | +**[filters](#filters)** | list, tuple, | tuple, | Various filter types to filter the execution result. | +**sensitivity** | str, | str, | Sensitivity level for outlier detection | must be one of ["LOW", "MEDIUM", "HIGH", ] +**[auxMeasures](#auxMeasures)** | list, tuple, | tuple, | Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +Attributes to be used in the computation. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Attributes to be used in the computation. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AttributeItem**](AttributeItem.md) | [**AttributeItem**](AttributeItem.md) | [**AttributeItem**](AttributeItem.md) | | + +# filters + +Various filter types to filter the execution result. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Various filter types to filter the execution result. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AbstractMeasureValueFilter](AbstractMeasureValueFilter.md) | [**AbstractMeasureValueFilter**](AbstractMeasureValueFilter.md) | [**AbstractMeasureValueFilter**](AbstractMeasureValueFilter.md) | | +[FilterDefinitionForSimpleMeasure](FilterDefinitionForSimpleMeasure.md) | [**FilterDefinitionForSimpleMeasure**](FilterDefinitionForSimpleMeasure.md) | [**FilterDefinitionForSimpleMeasure**](FilterDefinitionForSimpleMeasure.md) | | +[InlineFilterDefinition](InlineFilterDefinition.md) | [**InlineFilterDefinition**](InlineFilterDefinition.md) | [**InlineFilterDefinition**](InlineFilterDefinition.md) | | + +# measures + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | | + +# auxMeasures + +Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | [**MeasureItem**](MeasureItem.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/OutlierDetectionResponse.md b/gooddata-api-client/docs/models/OutlierDetectionResponse.md new file mode 100644 index 000000000..57ef96571 --- /dev/null +++ b/gooddata-api-client/docs/models/OutlierDetectionResponse.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.outlier_detection_response.OutlierDetectionResponse + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**links** | [**ExecutionLinks**](ExecutionLinks.md) | [**ExecutionLinks**](ExecutionLinks.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/OutlierDetectionResult.md b/gooddata-api-client/docs/models/OutlierDetectionResult.md new file mode 100644 index 000000000..4ed398cd6 --- /dev/null +++ b/gooddata-api-client/docs/models/OutlierDetectionResult.md @@ -0,0 +1,58 @@ +# gooddata_api_client.model.outlier_detection_result.OutlierDetectionResult + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[values](#values)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers. | +**[attribute](#attribute)** | list, tuple, None, | tuple, NoneClass, | Attribute values for outlier detection results. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attribute + +Attribute values for outlier detection results. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, None, | tuple, NoneClass, | Attribute values for outlier detection results. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# values + +Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[any_string_name](#any_string_name)** | list, tuple, None, | tuple, NoneClass, | any string name can be used but the value must be the correct type Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers. | [optional] + +# any_string_name + +Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, None, | tuple, NoneClass, | Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | None, decimal.Decimal, int, float, | NoneClass, decimal.Decimal, | Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Over.md b/gooddata-api-client/docs/models/Over.md new file mode 100644 index 000000000..b240008ae --- /dev/null +++ b/gooddata-api-client/docs/models/Over.md @@ -0,0 +1,27 @@ +# gooddata_api_client.model.over.Over + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[attributes](#attributes)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# attributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**IdentifierRef**](IdentifierRef.md) | [**IdentifierRef**](IdentifierRef.md) | [**IdentifierRef**](IdentifierRef.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/PageMetadata.md b/gooddata-api-client/docs/models/PageMetadata.md new file mode 100644 index 000000000..f2f4e18f5 --- /dev/null +++ b/gooddata-api-client/docs/models/PageMetadata.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.page_metadata.PageMetadata + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**number** | decimal.Decimal, int, | decimal.Decimal, | The number of the current page | [optional] value must be a 32 bit integer +**size** | decimal.Decimal, int, | decimal.Decimal, | The size of the current page | [optional] value must be a 32 bit integer +**totalElements** | decimal.Decimal, int, | decimal.Decimal, | The total number of elements | [optional] value must be a 32 bit integer +**totalPages** | decimal.Decimal, int, | decimal.Decimal, | The total number of pages | [optional] value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/PatchKnowledgeDocumentRequestDto.md b/gooddata-api-client/docs/models/PatchKnowledgeDocumentRequestDto.md new file mode 100644 index 000000000..c89cc62ed --- /dev/null +++ b/gooddata-api-client/docs/models/PatchKnowledgeDocumentRequestDto.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.patch_knowledge_document_request_dto.PatchKnowledgeDocumentRequestDto + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**isDisabled** | bool, | BoolClass, | | [optional] +**[scopes](#scopes)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# scopes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/PdfTableStyle.md b/gooddata-api-client/docs/models/PdfTableStyle.md new file mode 100644 index 000000000..a00b84c99 --- /dev/null +++ b/gooddata-api-client/docs/models/PdfTableStyle.md @@ -0,0 +1,32 @@ +# gooddata_api_client.model.pdf_table_style.PdfTableStyle + +Custom CSS styles for the table. (PDF, HTML) + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Custom CSS styles for the table. (PDF, HTML) | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**selector** | str, | str, | CSS selector where to apply given properties. | +**[properties](#properties)** | list, tuple, | tuple, | List of CSS properties. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# properties + +List of CSS properties. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of CSS properties. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**PdfTableStyleProperty**](PdfTableStyleProperty.md) | [**PdfTableStyleProperty**](PdfTableStyleProperty.md) | [**PdfTableStyleProperty**](PdfTableStyleProperty.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/PdfTableStyleProperty.md b/gooddata-api-client/docs/models/PdfTableStyleProperty.md new file mode 100644 index 000000000..8c28d0df8 --- /dev/null +++ b/gooddata-api-client/docs/models/PdfTableStyleProperty.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.pdf_table_style_property.PdfTableStyleProperty + +CSS property. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | CSS property. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**value** | str, | str, | CSS property value. | +**key** | str, | str, | CSS property key. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/PendingOperation.md b/gooddata-api-client/docs/models/PendingOperation.md new file mode 100644 index 000000000..248ffea7b --- /dev/null +++ b/gooddata-api-client/docs/models/PendingOperation.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.pending_operation.PendingOperation + +Operation that is still pending + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Operation that is still pending | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[Operation](Operation.md) | [**Operation**](Operation.md) | [**Operation**](Operation.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/PermissionsAssignment.md b/gooddata-api-client/docs/models/PermissionsAssignment.md new file mode 100644 index 000000000..3e82e9946 --- /dev/null +++ b/gooddata-api-client/docs/models/PermissionsAssignment.md @@ -0,0 +1,53 @@ +# gooddata_api_client.model.permissions_assignment.PermissionsAssignment + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[assignees](#assignees)** | list, tuple, | tuple, | | +**[dataSources](#dataSources)** | list, tuple, | tuple, | | [optional] +**[workspaces](#workspaces)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# assignees + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AssigneeIdentifier**](AssigneeIdentifier.md) | [**AssigneeIdentifier**](AssigneeIdentifier.md) | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | + +# dataSources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**UserManagementDataSourcePermissionAssignment**](UserManagementDataSourcePermissionAssignment.md) | [**UserManagementDataSourcePermissionAssignment**](UserManagementDataSourcePermissionAssignment.md) | [**UserManagementDataSourcePermissionAssignment**](UserManagementDataSourcePermissionAssignment.md) | | + +# workspaces + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**UserManagementWorkspacePermissionAssignment**](UserManagementWorkspacePermissionAssignment.md) | [**UserManagementWorkspacePermissionAssignment**](UserManagementWorkspacePermissionAssignment.md) | [**UserManagementWorkspacePermissionAssignment**](UserManagementWorkspacePermissionAssignment.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/PermissionsForAssigneeRule.md b/gooddata-api-client/docs/models/PermissionsForAssigneeRule.md new file mode 100644 index 000000000..69cc52850 --- /dev/null +++ b/gooddata-api-client/docs/models/PermissionsForAssigneeRule.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.permissions_for_assignee_rule.PermissionsForAssigneeRule + +Desired levels of permissions for a collection of assignees identified by a rule. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Desired levels of permissions for a collection of assignees identified by a rule. | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[DashboardPermissionsAssignment](DashboardPermissionsAssignment.md) | [**DashboardPermissionsAssignment**](DashboardPermissionsAssignment.md) | [**DashboardPermissionsAssignment**](DashboardPermissionsAssignment.md) | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**assigneeRule** | [**AssigneeRule**](AssigneeRule.md) | [**AssigneeRule**](AssigneeRule.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ProvisionDatabaseInstanceRequest.md b/gooddata-api-client/docs/models/ProvisionDatabaseInstanceRequest.md new file mode 100644 index 000000000..61880a224 --- /dev/null +++ b/gooddata-api-client/docs/models/ProvisionDatabaseInstanceRequest.md @@ -0,0 +1,32 @@ +# gooddata_api_client.model.provision_database_instance_request.ProvisionDatabaseInstanceRequest + +Request to provision a new AILake Database instance + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Request to provision a new AILake Database instance | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[storageIds](#storageIds)** | list, tuple, | tuple, | Set of ids of the storage instances this database instance should access. | +**name** | str, | str, | Name of the database instance | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# storageIds + +Set of ids of the storage instances this database instance should access. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Set of ids of the storage instances this database instance should access. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Set of ids of the storage instances this database instance should access. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/QualityIssue.md b/gooddata-api-client/docs/models/QualityIssue.md new file mode 100644 index 000000000..ba314812b --- /dev/null +++ b/gooddata-api-client/docs/models/QualityIssue.md @@ -0,0 +1,58 @@ +# gooddata_api_client.model.quality_issue.QualityIssue + +List of quality issues (available when status is COMPLETED) + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | List of quality issues (available when status is COMPLETED) | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**severity** | str, | str, | Severity level | must be one of ["WARNING", "INFO", ] +**code** | str, | str, | Quality issue code | +**[objects](#objects)** | list, tuple, | tuple, | List of objects affected by this quality issue | +**[detail](#detail)** | dict, frozendict.frozendict, | frozendict.frozendict, | Detailed information about the quality issue | +**id** | str, | str, | Unique identifier for the quality issue | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# detail + +Detailed information about the quality issue + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Detailed information about the quality issue | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[any_string_name](#any_string_name)** | dict, frozendict.frozendict, | frozendict.frozendict, | any string name can be used but the value must be the correct type Detailed information about the quality issue | [optional] + +# any_string_name + +Detailed information about the quality issue + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Detailed information about the quality issue | + +# objects + +List of objects affected by this quality issue + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of objects affected by this quality issue | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**QualityIssueObject**](QualityIssueObject.md) | [**QualityIssueObject**](QualityIssueObject.md) | [**QualityIssueObject**](QualityIssueObject.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/QualityIssueObject.md b/gooddata-api-client/docs/models/QualityIssueObject.md new file mode 100644 index 000000000..7419d5b7c --- /dev/null +++ b/gooddata-api-client/docs/models/QualityIssueObject.md @@ -0,0 +1,20 @@ +# gooddata_api_client.model.quality_issue_object.QualityIssueObject + +List of objects affected by this quality issue + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | List of objects affected by this quality issue | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Object ID | +**title** | str, | str, | Object title | +**type** | str, | str, | Object type | +**workspaceId** | str, | str, | Workspace ID where the object belongs | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/QualityIssuesCalculationStatusResponse.md b/gooddata-api-client/docs/models/QualityIssuesCalculationStatusResponse.md new file mode 100644 index 000000000..39a382f0f --- /dev/null +++ b/gooddata-api-client/docs/models/QualityIssuesCalculationStatusResponse.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.quality_issues_calculation_status_response.QualityIssuesCalculationStatusResponse + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**status** | str, | str, | Current status of the calculation | must be one of ["RUNNING", "SYNCING", "COMPLETED", "FAILED", "CANCELLED", "NOT_FOUND", "DISABLED", ] +**error** | str, | str, | Error message (available when status is FAILED or NOT_FOUND) | [optional] +**[issues](#issues)** | list, tuple, | tuple, | List of quality issues (available when status is COMPLETED) | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# issues + +List of quality issues (available when status is COMPLETED) + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of quality issues (available when status is COMPLETED) | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**QualityIssue**](QualityIssue.md) | [**QualityIssue**](QualityIssue.md) | [**QualityIssue**](QualityIssue.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Range.md b/gooddata-api-client/docs/models/Range.md new file mode 100644 index 000000000..c5d32d1a6 --- /dev/null +++ b/gooddata-api-client/docs/models/Range.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.range.Range + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**measure** | [**LocalIdentifier**](LocalIdentifier.md) | [**LocalIdentifier**](LocalIdentifier.md) | | +**from** | [**Value**](Value.md) | [**Value**](Value.md) | | +**to** | [**Value**](Value.md) | [**Value**](Value.md) | | +**operator** | str, | str, | | must be one of ["BETWEEN", "NOT_BETWEEN", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/RangeCondition.md b/gooddata-api-client/docs/models/RangeCondition.md new file mode 100644 index 000000000..f66fdd40b --- /dev/null +++ b/gooddata-api-client/docs/models/RangeCondition.md @@ -0,0 +1,32 @@ +# gooddata_api_client.model.range_condition.RangeCondition + +Condition that checks if the metric value is within a given range. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Condition that checks if the metric value is within a given range. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[range](#range)** | dict, frozendict.frozendict, | frozendict.frozendict, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# range + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**from** | decimal.Decimal, int, float, | decimal.Decimal, | | +**to** | decimal.Decimal, int, float, | decimal.Decimal, | | +**operator** | str, | str, | | must be one of ["BETWEEN", "NOT_BETWEEN", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/RangeWrapper.md b/gooddata-api-client/docs/models/RangeWrapper.md new file mode 100644 index 000000000..f87908223 --- /dev/null +++ b/gooddata-api-client/docs/models/RangeWrapper.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.range_wrapper.RangeWrapper + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**range** | [**Range**](Range.md) | [**Range**](Range.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/RawCustomLabel.md b/gooddata-api-client/docs/models/RawCustomLabel.md new file mode 100644 index 000000000..a0c4c6786 --- /dev/null +++ b/gooddata-api-client/docs/models/RawCustomLabel.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.raw_custom_label.RawCustomLabel + +Custom label object override. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Custom label object override. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**title** | str, | str, | Override value. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/RawCustomMetric.md b/gooddata-api-client/docs/models/RawCustomMetric.md new file mode 100644 index 000000000..43fe93e4f --- /dev/null +++ b/gooddata-api-client/docs/models/RawCustomMetric.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.raw_custom_metric.RawCustomMetric + +Custom metric object override. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Custom metric object override. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**title** | str, | str, | Metric title override. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/RawCustomOverride.md b/gooddata-api-client/docs/models/RawCustomOverride.md new file mode 100644 index 000000000..960437057 --- /dev/null +++ b/gooddata-api-client/docs/models/RawCustomOverride.md @@ -0,0 +1,46 @@ +# gooddata_api_client.model.raw_custom_override.RawCustomOverride + +Custom cell value overrides (IDs will be replaced with specified values). + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Custom cell value overrides (IDs will be replaced with specified values). | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[labels](#labels)** | dict, frozendict.frozendict, | frozendict.frozendict, | Map of CustomLabels with keys used as placeholders in export result. | [optional] +**[metrics](#metrics)** | dict, frozendict.frozendict, | frozendict.frozendict, | Map of CustomMetrics with keys used as placeholders in export result. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# labels + +Map of CustomLabels with keys used as placeholders in export result. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Map of CustomLabels with keys used as placeholders in export result. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**RawCustomLabel**](RawCustomLabel.md) | [**RawCustomLabel**](RawCustomLabel.md) | any string name can be used but the value must be the correct type | [optional] + +# metrics + +Map of CustomMetrics with keys used as placeholders in export result. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Map of CustomMetrics with keys used as placeholders in export result. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | [**RawCustomMetric**](RawCustomMetric.md) | [**RawCustomMetric**](RawCustomMetric.md) | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/RawExportAutomationRequest.md b/gooddata-api-client/docs/models/RawExportAutomationRequest.md new file mode 100644 index 000000000..9349eff24 --- /dev/null +++ b/gooddata-api-client/docs/models/RawExportAutomationRequest.md @@ -0,0 +1,23 @@ +# gooddata_api_client.model.raw_export_automation_request.RawExportAutomationRequest + +Export request object describing the export properties and overrides for raw exports. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Export request object describing the export properties and overrides for raw exports. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**execution** | [**AFM**](AFM.md) | [**AFM**](AFM.md) | | +**fileName** | str, | str, | Filename of downloaded file without extension. | +**format** | str, | str, | Requested resulting file type. | must be one of ["ARROW_FILE", "ARROW_STREAM", "CSV", ] +**customOverride** | [**RawCustomOverride**](RawCustomOverride.md) | [**RawCustomOverride**](RawCustomOverride.md) | | [optional] +**delimiter** | str, | str, | Set column delimiter. (CSV) | [optional] +**executionSettings** | [**ExecutionSettings**](ExecutionSettings.md) | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] +**metadata** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/RawExportRequest.md b/gooddata-api-client/docs/models/RawExportRequest.md new file mode 100644 index 000000000..960dbe87f --- /dev/null +++ b/gooddata-api-client/docs/models/RawExportRequest.md @@ -0,0 +1,22 @@ +# gooddata_api_client.model.raw_export_request.RawExportRequest + +Export request object describing the export properties and overrides for raw exports. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Export request object describing the export properties and overrides for raw exports. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**execution** | [**AFM**](AFM.md) | [**AFM**](AFM.md) | | +**fileName** | str, | str, | Filename of downloaded file without extension. | +**format** | str, | str, | Requested resulting file type. | must be one of ["ARROW_FILE", "ARROW_STREAM", "CSV", ] +**customOverride** | [**RawCustomOverride**](RawCustomOverride.md) | [**RawCustomOverride**](RawCustomOverride.md) | | [optional] +**delimiter** | str, | str, | Set column delimiter. (CSV) | [optional] +**executionSettings** | [**ExecutionSettings**](ExecutionSettings.md) | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Reasoning.md b/gooddata-api-client/docs/models/Reasoning.md new file mode 100644 index 000000000..cca76c6f9 --- /dev/null +++ b/gooddata-api-client/docs/models/Reasoning.md @@ -0,0 +1,32 @@ +# gooddata_api_client.model.reasoning.Reasoning + +Reasoning wrapper containing steps taken during request handling. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Reasoning wrapper containing steps taken during request handling. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[steps](#steps)** | list, tuple, | tuple, | Steps taken during processing, showing the AI's reasoning process. | +**answer** | str, | str, | Final answer/reasoning from the use case result. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# steps + +Steps taken during processing, showing the AI's reasoning process. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Steps taken during processing, showing the AI's reasoning process. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ReasoningStep**](ReasoningStep.md) | [**ReasoningStep**](ReasoningStep.md) | [**ReasoningStep**](ReasoningStep.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ReasoningStep.md b/gooddata-api-client/docs/models/ReasoningStep.md new file mode 100644 index 000000000..e969d7ce0 --- /dev/null +++ b/gooddata-api-client/docs/models/ReasoningStep.md @@ -0,0 +1,32 @@ +# gooddata_api_client.model.reasoning_step.ReasoningStep + +Steps taken during processing, showing the AI's reasoning process. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Steps taken during processing, showing the AI's reasoning process. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[thoughts](#thoughts)** | list, tuple, | tuple, | Detailed thoughts/messages within this step. | +**title** | str, | str, | Title describing this reasoning step. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# thoughts + +Detailed thoughts/messages within this step. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Detailed thoughts/messages within this step. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**Thought**](Thought.md) | [**Thought**](Thought.md) | [**Thought**](Thought.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ReferenceSourceColumn.md b/gooddata-api-client/docs/models/ReferenceSourceColumn.md new file mode 100644 index 000000000..6d6750e8d --- /dev/null +++ b/gooddata-api-client/docs/models/ReferenceSourceColumn.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.reference_source_column.ReferenceSourceColumn + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**column** | str, | str, | | +**target** | [**DatasetGrain**](DatasetGrain.md) | [**DatasetGrain**](DatasetGrain.md) | | +**dataType** | str, | str, | | [optional] must be one of ["INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", ] +**isNullable** | bool, | BoolClass, | | [optional] +**nullValue** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Relative.md b/gooddata-api-client/docs/models/Relative.md new file mode 100644 index 000000000..e6e9bbe0c --- /dev/null +++ b/gooddata-api-client/docs/models/Relative.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.relative.Relative + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**measure** | [**ArithmeticMeasure**](ArithmeticMeasure.md) | [**ArithmeticMeasure**](ArithmeticMeasure.md) | | +**threshold** | [**Value**](Value.md) | [**Value**](Value.md) | | +**operator** | str, | str, | Relative condition operator. INCREASES_BY - the metric increases by the specified value. DECREASES_BY - the metric decreases by the specified value. CHANGES_BY - the metric increases or decreases by the specified value. | must be one of ["INCREASES_BY", "DECREASES_BY", "CHANGES_BY", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/RelativeBoundedDateFilter.md b/gooddata-api-client/docs/models/RelativeBoundedDateFilter.md new file mode 100644 index 000000000..7f37f01c9 --- /dev/null +++ b/gooddata-api-client/docs/models/RelativeBoundedDateFilter.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.relative_bounded_date_filter.RelativeBoundedDateFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**granularity** | str, | str, | | must be one of ["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.fiscal_month", "GDC.time.fiscal_quarter", "GDC.time.fiscal_year", ] +**from** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer +**to** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/RelativeWrapper.md b/gooddata-api-client/docs/models/RelativeWrapper.md new file mode 100644 index 000000000..4e75a62dd --- /dev/null +++ b/gooddata-api-client/docs/models/RelativeWrapper.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.relative_wrapper.RelativeWrapper + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**relative** | [**Relative**](Relative.md) | [**Relative**](Relative.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ResolvedLlmEndpoint.md b/gooddata-api-client/docs/models/ResolvedLlmEndpoint.md new file mode 100644 index 000000000..9ac98f838 --- /dev/null +++ b/gooddata-api-client/docs/models/ResolvedLlmEndpoint.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.resolved_llm_endpoint.ResolvedLlmEndpoint + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Endpoint Id | +**title** | str, | str, | Endpoint Title | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ResolvedLlmEndpoints.md b/gooddata-api-client/docs/models/ResolvedLlmEndpoints.md new file mode 100644 index 000000000..739bb8798 --- /dev/null +++ b/gooddata-api-client/docs/models/ResolvedLlmEndpoints.md @@ -0,0 +1,27 @@ +# gooddata_api_client.model.resolved_llm_endpoints.ResolvedLlmEndpoints + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[data](#data)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# data + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ResolvedLlmEndpoint**](ResolvedLlmEndpoint.md) | [**ResolvedLlmEndpoint**](ResolvedLlmEndpoint.md) | [**ResolvedLlmEndpoint**](ResolvedLlmEndpoint.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/RouteResult.md b/gooddata-api-client/docs/models/RouteResult.md new file mode 100644 index 000000000..6f86d88b2 --- /dev/null +++ b/gooddata-api-client/docs/models/RouteResult.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.route_result.RouteResult + +Question -> Use Case routing. May contain final answer is a special use case is not required. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Question -> Use Case routing. May contain final answer is a special use case is not required. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**useCase** | str, | str, | Use case where LLM routed based on question. | must be one of ["INVALID", "GENERAL", "SEARCH", "CREATE_VISUALIZATION", "EXTEND_VISUALIZATION", "HOWTO", "CHANGE_ANALYSIS", "ALERT", ] +**reasoning** | str, | str, | Explanation why LLM picked this use case. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/RsaSpecification.md b/gooddata-api-client/docs/models/RsaSpecification.md new file mode 100644 index 000000000..4def210b5 --- /dev/null +++ b/gooddata-api-client/docs/models/RsaSpecification.md @@ -0,0 +1,34 @@ +# gooddata_api_client.model.rsa_specification.RsaSpecification + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**kty** | str, | str, | | must be one of ["RSA", ] +**e** | str, | str, | | +**use** | str, | str, | | must be one of ["sig", ] +**kid** | str, | str, | | +**alg** | str, | str, | | must be one of ["RS256", "RS384", "RS512", ] +**n** | str, | str, | | +**[x5c](#x5c)** | list, tuple, | tuple, | | [optional] +**x5t** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# x5c + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/RulePermission.md b/gooddata-api-client/docs/models/RulePermission.md new file mode 100644 index 000000000..fc4e47d5d --- /dev/null +++ b/gooddata-api-client/docs/models/RulePermission.md @@ -0,0 +1,32 @@ +# gooddata_api_client.model.rule_permission.RulePermission + +List of rules + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | List of rules | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**type** | str, | str, | Type of the rule | +**[permissions](#permissions)** | list, tuple, | tuple, | Permissions granted by the rule | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# permissions + +Permissions granted by the rule + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Permissions granted by the rule | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**GrantedPermission**](GrantedPermission.md) | [**GrantedPermission**](GrantedPermission.md) | [**GrantedPermission**](GrantedPermission.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/RunServiceCommandRequest.md b/gooddata-api-client/docs/models/RunServiceCommandRequest.md new file mode 100644 index 000000000..a5bab7f01 --- /dev/null +++ b/gooddata-api-client/docs/models/RunServiceCommandRequest.md @@ -0,0 +1,32 @@ +# gooddata_api_client.model.run_service_command_request.RunServiceCommandRequest + +Request to run an AI Lake Service Command + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Request to run an AI Lake Service Command | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[context](#context)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | The context to pass to the command | [optional] +**payload** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# context + +The context to pass to the command + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | The context to pass to the command | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | None, str, | NoneClass, str, | any string name can be used but the value must be the correct type The context to pass to the command | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/RunningSection.md b/gooddata-api-client/docs/models/RunningSection.md new file mode 100644 index 000000000..33569741f --- /dev/null +++ b/gooddata-api-client/docs/models/RunningSection.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.running_section.RunningSection + +Footer section of the slide + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Footer section of the slide | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**left** | None, str, | NoneClass, str, | Either {{logo}} variable or custom text with combination of other variables. | [optional] +**right** | None, str, | NoneClass, str, | Either {{logo}} variable or custom text with combination of other variables. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/SavedVisualization.md b/gooddata-api-client/docs/models/SavedVisualization.md new file mode 100644 index 000000000..5fa21ab4a --- /dev/null +++ b/gooddata-api-client/docs/models/SavedVisualization.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.saved_visualization.SavedVisualization + +Created and saved visualization IDs. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Created and saved visualization IDs. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**savedVisualizationId** | str, | str, | Saved visualization ID. | +**createdVisualizationId** | str, | str, | Created visualization ID. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/SearchKnowledgeResponseDto.md b/gooddata-api-client/docs/models/SearchKnowledgeResponseDto.md new file mode 100644 index 000000000..9b8bc05e0 --- /dev/null +++ b/gooddata-api-client/docs/models/SearchKnowledgeResponseDto.md @@ -0,0 +1,28 @@ +# gooddata_api_client.model.search_knowledge_response_dto.SearchKnowledgeResponseDto + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[results](#results)** | list, tuple, | tuple, | | +**statistics** | [**SearchStatisticsDto**](SearchStatisticsDto.md) | [**SearchStatisticsDto**](SearchStatisticsDto.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# results + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**KnowledgeSearchResultDto**](KnowledgeSearchResultDto.md) | [**KnowledgeSearchResultDto**](KnowledgeSearchResultDto.md) | [**KnowledgeSearchResultDto**](KnowledgeSearchResultDto.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/SearchRelationshipObject.md b/gooddata-api-client/docs/models/SearchRelationshipObject.md new file mode 100644 index 000000000..c9a306bb0 --- /dev/null +++ b/gooddata-api-client/docs/models/SearchRelationshipObject.md @@ -0,0 +1,22 @@ +# gooddata_api_client.model.search_relationship_object.SearchRelationshipObject + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**targetObjectTitle** | str, | str, | Target object title. | +**sourceObjectType** | str, | str, | Source object type, e.g. dashboard. | +**targetObjectId** | str, | str, | Target object ID. | +**sourceWorkspaceId** | str, | str, | Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located. | +**targetWorkspaceId** | str, | str, | Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located. | +**sourceObjectId** | str, | str, | Source object ID. | +**sourceObjectTitle** | str, | str, | Source object title. | +**targetObjectType** | str, | str, | Target object type, e.g. visualization. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/SearchRequest.md b/gooddata-api-client/docs/models/SearchRequest.md new file mode 100644 index 000000000..eec9b3a3a --- /dev/null +++ b/gooddata-api-client/docs/models/SearchRequest.md @@ -0,0 +1,81 @@ +# gooddata_api_client.model.search_request.SearchRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**question** | str, | str, | Keyword/sentence is input for search. | +**[allowedRelationshipTypes](#allowedRelationshipTypes)** | list, tuple, | tuple, | 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] +**deepSearch** | bool, | BoolClass, | 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 +**enableHybridSearch** | bool, | BoolClass, | 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 +**[excludeTags](#excludeTags)** | list, tuple, | tuple, | 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] +**includeHidden** | bool, | BoolClass, | 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 +**[includeTags](#includeTags)** | list, tuple, | tuple, | 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** | decimal.Decimal, int, | decimal.Decimal, | 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 10value must be a 32 bit integer +**[objectTypes](#objectTypes)** | list, tuple, | tuple, | List of object types to search for. | [optional] +**relevantScoreThreshold** | decimal.Decimal, int, float, | decimal.Decimal, | 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.3value must be a 64 bit float +**titleToDescriptorRatio** | decimal.Decimal, int, float, | decimal.Decimal, | Temporary for experiments. Ratio of title score to descriptor score. | [optional] if omitted the server will use the default value of 0.7value must be a 64 bit float +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# allowedRelationshipTypes + +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. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | 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. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AllowedRelationshipType**](AllowedRelationshipType.md) | [**AllowedRelationshipType**](AllowedRelationshipType.md) | [**AllowedRelationshipType**](AllowedRelationshipType.md) | | + +# excludeTags + +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. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | 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. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Tag to exclude. | + +# includeTags + +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. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | 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. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Tag to include. | + +# objectTypes + +List of object types to search for. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of object types to search for. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | Object type to search for. | must be one of ["attribute", "metric", "fact", "label", "date", "dataset", "visualization", "dashboard", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/SearchResult.md b/gooddata-api-client/docs/models/SearchResult.md new file mode 100644 index 000000000..0bf577507 --- /dev/null +++ b/gooddata-api-client/docs/models/SearchResult.md @@ -0,0 +1,41 @@ +# gooddata_api_client.model.search_result.SearchResult + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[relationships](#relationships)** | list, tuple, | tuple, | | +**reasoning** | str, | str, | DEPRECATED: Use top-level reasoning.steps instead. If something is not working properly this field will contain explanation. | +**[results](#results)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# relationships + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**SearchRelationshipObject**](SearchRelationshipObject.md) | [**SearchRelationshipObject**](SearchRelationshipObject.md) | [**SearchRelationshipObject**](SearchRelationshipObject.md) | | + +# results + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**SearchResultObject**](SearchResultObject.md) | [**SearchResultObject**](SearchResultObject.md) | [**SearchResultObject**](SearchResultObject.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/SearchResultObject.md b/gooddata-api-client/docs/models/SearchResultObject.md new file mode 100644 index 000000000..d185a992f --- /dev/null +++ b/gooddata-api-client/docs/models/SearchResultObject.md @@ -0,0 +1,40 @@ +# gooddata_api_client.model.search_result_object.SearchResultObject + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Object ID. | +**title** | str, | str, | Object title. | +**type** | str, | str, | Object type, e.g. dashboard. | +**workspaceId** | str, | str, | Workspace ID. | +**createdAt** | str, datetime, | str, | Timestamp when object was created. | [optional] value must conform to RFC-3339 date-time +**description** | str, | str, | Object description. | [optional] +**isHidden** | bool, | BoolClass, | If true, this object is hidden from AI search results by default. | [optional] +**modifiedAt** | str, datetime, | str, | Timestamp when object was last modified. | [optional] value must conform to RFC-3339 date-time +**score** | decimal.Decimal, int, float, | decimal.Decimal, | Result score calculated by a similarity search algorithm (cosine_distance). | [optional] value must be a 32 bit float +**scoreDescriptor** | decimal.Decimal, int, float, | decimal.Decimal, | Result score for descriptor containing(now) description and tags. | [optional] value must be a 32 bit float +**scoreExactMatch** | decimal.Decimal, int, | decimal.Decimal, | Result score for exact match(id/title). 1/1000. Other scores are multiplied by this. | [optional] value must be a 32 bit integer +**scoreTitle** | decimal.Decimal, int, float, | decimal.Decimal, | Result score for object title. | [optional] value must be a 32 bit float +**[tags](#tags)** | list, tuple, | tuple, | | [optional] +**visualizationUrl** | str, | str, | If the object is visualization, this field defines the type of visualization. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# tags + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | List of tags assigned to the 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/models/SearchStatisticsDto.md b/gooddata-api-client/docs/models/SearchStatisticsDto.md new file mode 100644 index 000000000..ac79ea97c --- /dev/null +++ b/gooddata-api-client/docs/models/SearchStatisticsDto.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.search_statistics_dto.SearchStatisticsDto + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**totalResults** | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer +**averageSimilarityScore** | decimal.Decimal, int, float, | decimal.Decimal, | | value must be a 32 bit float +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/SectionSlideTemplate.md b/gooddata-api-client/docs/models/SectionSlideTemplate.md new file mode 100644 index 000000000..3a57dbe09 --- /dev/null +++ b/gooddata-api-client/docs/models/SectionSlideTemplate.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.section_slide_template.SectionSlideTemplate + +Settings for section slide. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Settings for section slide. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**backgroundImage** | bool, | BoolClass, | Show background image on the slide. | [optional] if omitted the server will use the default value of True +**footer** | [**RunningSection**](RunningSection.md) | [**RunningSection**](RunningSection.md) | | [optional] +**header** | [**RunningSection**](RunningSection.md) | [**RunningSection**](RunningSection.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ServiceInfo.md b/gooddata-api-client/docs/models/ServiceInfo.md new file mode 100644 index 000000000..172649cbc --- /dev/null +++ b/gooddata-api-client/docs/models/ServiceInfo.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.service_info.ServiceInfo + +Non-sensitive metadata for an AI Lake pipeline + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Non-sensitive metadata for an AI Lake pipeline | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**name** | str, | str, | Human-readable name of the service | +**serviceId** | str, | str, | Internal identifier for the service configuration (UUID) | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/SetCertificationRequest.md b/gooddata-api-client/docs/models/SetCertificationRequest.md new file mode 100644 index 000000000..53c54d293 --- /dev/null +++ b/gooddata-api-client/docs/models/SetCertificationRequest.md @@ -0,0 +1,20 @@ +# gooddata_api_client.model.set_certification_request.SetCertificationRequest + +Request to set or clear the certification of a workspace entity. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Request to set or clear the certification of a workspace entity. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | ID of the entity. | +**type** | str, | str, | Type of the entity. | must be one of ["metric", "visualizationObject", "analyticalDashboard", ] +**message** | None, str, | NoneClass, str, | Optional message associated with the certification. | [optional] +**status** | None, str, | NoneClass, str, | Certification status of the entity. | [optional] must be one of ["CERTIFIED", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Skeleton.md b/gooddata-api-client/docs/models/Skeleton.md new file mode 100644 index 000000000..814bbb862 --- /dev/null +++ b/gooddata-api-client/docs/models/Skeleton.md @@ -0,0 +1,35 @@ +# gooddata_api_client.model.skeleton.Skeleton + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[content](#content)** | list, tuple, | tuple, | | [optional] +**href** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# content + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# items + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/SlidesExportRequest.md b/gooddata-api-client/docs/models/SlidesExportRequest.md new file mode 100644 index 000000000..044c849a3 --- /dev/null +++ b/gooddata-api-client/docs/models/SlidesExportRequest.md @@ -0,0 +1,51 @@ +# gooddata_api_client.model.slides_export_request.SlidesExportRequest + +Export request object describing the export properties and metadata for slides exports. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Export request object describing the export properties and metadata for slides exports. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**fileName** | str, | str, | File name to be used for retrieving the pdf document. | +**format** | str, | str, | Requested resulting file type. | must be one of ["PDF", "PPTX", ] +**dashboardId** | str, | str, | Dashboard identifier | [optional] +**metadata** | [**JsonNode**](JsonNode.md) | [**JsonNode**](JsonNode.md) | | [optional] +**templateId** | None, str, | NoneClass, str, | Export template identifier. | [optional] +**[visualizationIds](#visualizationIds)** | list, tuple, | tuple, | List of visualization ids to be exported. Note that only one visualization is currently supported. | [optional] +**[widgetIds](#widgetIds)** | list, tuple, | tuple, | List of widget identifiers to be exported. Note that only one widget is currently supported. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# visualizationIds + +List of visualization ids to be exported. Note that only one visualization is currently supported. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of visualization ids to be exported. Note that only one visualization is currently supported. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +# widgetIds + +List of widget identifiers to be exported. Note that only one widget is currently supported. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | List of widget identifiers to be exported. Note that only one widget is currently supported. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/SmartFunctionResponse.md b/gooddata-api-client/docs/models/SmartFunctionResponse.md new file mode 100644 index 000000000..da85d2b59 --- /dev/null +++ b/gooddata-api-client/docs/models/SmartFunctionResponse.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.smart_function_response.SmartFunctionResponse + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**links** | [**ExecutionLinks**](ExecutionLinks.md) | [**ExecutionLinks**](ExecutionLinks.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Smtp.md b/gooddata-api-client/docs/models/Smtp.md new file mode 100644 index 000000000..ce2244620 --- /dev/null +++ b/gooddata-api-client/docs/models/Smtp.md @@ -0,0 +1,48 @@ +# gooddata_api_client.model.smtp.Smtp + +Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**type** | str, | str, | The destination type. | must be one of ["SMTP", ] +**fromEmail** | str, | str, | E-mail address to send notifications from. | [optional] if omitted the server will use the default value of no-reply@gooddata.com +**fromEmailName** | str, | str, | An optional e-mail name to send notifications from. | [optional] if omitted the server will use the default value of "GoodData" +**host** | str, | str, | The SMTP server address. | [optional] +**password** | str, | str, | The SMTP server password. | [optional] +**port** | decimal.Decimal, int, | decimal.Decimal, | The SMTP server port. | [optional] must be one of [25, 465, 587, 2525, ] value must be a 32 bit integer +**username** | str, | str, | The SMTP server username. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**fromEmail** | str, | str, | E-mail address to send notifications from. | [optional] if omitted the server will use the default value of no-reply@gooddata.com +**fromEmailName** | str, | str, | An optional e-mail name to send notifications from. | [optional] if omitted the server will use the default value of "GoodData" +**host** | str, | str, | The SMTP server address. | [optional] +**password** | str, | str, | The SMTP server password. | [optional] +**port** | decimal.Decimal, int, | decimal.Decimal, | The SMTP server port. | [optional] must be one of [25, 465, 587, 2525, ] value must be a 32 bit integer +**type** | str, | str, | The destination type. | [optional] must be one of ["SMTP", ] +**username** | str, | str, | The SMTP server username. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/SqlQuery.md b/gooddata-api-client/docs/models/SqlQuery.md new file mode 100644 index 000000000..e00cf41f5 --- /dev/null +++ b/gooddata-api-client/docs/models/SqlQuery.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.sql_query.SqlQuery + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[ColumnLocation](ColumnLocation.md) | [**ColumnLocation**](ColumnLocation.md) | [**ColumnLocation**](ColumnLocation.md) | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**sql** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/SucceededOperation.md b/gooddata-api-client/docs/models/SucceededOperation.md new file mode 100644 index 000000000..91b422adb --- /dev/null +++ b/gooddata-api-client/docs/models/SucceededOperation.md @@ -0,0 +1,40 @@ +# gooddata_api_client.model.succeeded_operation.SucceededOperation + +Operation that has succeeded + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Operation that has succeeded | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[Operation](Operation.md) | [**Operation**](Operation.md) | [**Operation**](Operation.md) | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[result](#result)** | dict, frozendict.frozendict, | frozendict.frozendict, | Operation-specific result payload, can be missing for operations like delete | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# result + +Operation-specific result payload, can be missing for operations like delete + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Operation-specific result payload, can be missing for operations like delete | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Suggestion.md b/gooddata-api-client/docs/models/Suggestion.md new file mode 100644 index 000000000..d4c2c0125 --- /dev/null +++ b/gooddata-api-client/docs/models/Suggestion.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.suggestion.Suggestion + +List of suggestions for next steps. Filled when no visualization was created, suggests alternatives. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | List of suggestions for next steps. Filled when no visualization was created, suggests alternatives. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**query** | str, | str, | Suggestion query | +**label** | str, | str, | Suggestion button label | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/SwitchIdentityProviderRequest.md b/gooddata-api-client/docs/models/SwitchIdentityProviderRequest.md new file mode 100644 index 000000000..a746020c2 --- /dev/null +++ b/gooddata-api-client/docs/models/SwitchIdentityProviderRequest.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.switch_identity_provider_request.SwitchIdentityProviderRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**idpId** | str, | str, | Identity provider ID to set as active for the organization. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Table.md b/gooddata-api-client/docs/models/Table.md new file mode 100644 index 000000000..c81a62377 --- /dev/null +++ b/gooddata-api-client/docs/models/Table.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.table.Table + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[ColumnLocation](ColumnLocation.md) | [**ColumnLocation**](ColumnLocation.md) | [**ColumnLocation**](ColumnLocation.md) | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**tableName** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/TableOverride.md b/gooddata-api-client/docs/models/TableOverride.md new file mode 100644 index 000000000..edb886bbc --- /dev/null +++ b/gooddata-api-client/docs/models/TableOverride.md @@ -0,0 +1,46 @@ +# gooddata_api_client.model.table_override.TableOverride + +Table override settings. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Table override settings. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[path](#path)** | list, tuple, | tuple, | Path for the table. | +**[columns](#columns)** | list, tuple, | tuple, | An array of column overrides | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# columns + +An array of column overrides + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | An array of column overrides | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ColumnOverride**](ColumnOverride.md) | [**ColumnOverride**](ColumnOverride.md) | [**ColumnOverride**](ColumnOverride.md) | | + +# path + +Path for the table. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Path for the table. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/TestDestinationRequest.md b/gooddata-api-client/docs/models/TestDestinationRequest.md new file mode 100644 index 000000000..2b9d40adf --- /dev/null +++ b/gooddata-api-client/docs/models/TestDestinationRequest.md @@ -0,0 +1,48 @@ +# gooddata_api_client.model.test_destination_request.TestDestinationRequest + +Request body with notification channel destination to test. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Request body with notification channel destination to test. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[destination](#destination)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +**[externalRecipients](#externalRecipients)** | list, tuple, None, | tuple, NoneClass, | External recipients of the test result. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# destination + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[DefaultSmtp](DefaultSmtp.md) | [**DefaultSmtp**](DefaultSmtp.md) | [**DefaultSmtp**](DefaultSmtp.md) | | +[InPlatform](InPlatform.md) | [**InPlatform**](InPlatform.md) | [**InPlatform**](InPlatform.md) | | +[Smtp](Smtp.md) | [**Smtp**](Smtp.md) | [**Smtp**](Smtp.md) | | +[Webhook](Webhook.md) | [**Webhook**](Webhook.md) | [**Webhook**](Webhook.md) | | + +# externalRecipients + +External recipients of the test result. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, None, | tuple, NoneClass, | External recipients of the test result. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**AutomationExternalRecipient**](AutomationExternalRecipient.md) | [**AutomationExternalRecipient**](AutomationExternalRecipient.md) | [**AutomationExternalRecipient**](AutomationExternalRecipient.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/TestLlmProviderDefinitionRequest.md b/gooddata-api-client/docs/models/TestLlmProviderDefinitionRequest.md new file mode 100644 index 000000000..3c4a6f315 --- /dev/null +++ b/gooddata-api-client/docs/models/TestLlmProviderDefinitionRequest.md @@ -0,0 +1,45 @@ +# gooddata_api_client.model.test_llm_provider_definition_request.TestLlmProviderDefinitionRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[providerConfig](#providerConfig)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | +**[models](#models)** | list, tuple, | tuple, | Models to test. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# providerConfig + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### oneOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[AwsBedrockProviderConfig](AwsBedrockProviderConfig.md) | [**AwsBedrockProviderConfig**](AwsBedrockProviderConfig.md) | [**AwsBedrockProviderConfig**](AwsBedrockProviderConfig.md) | | +[AzureFoundryProviderConfig](AzureFoundryProviderConfig.md) | [**AzureFoundryProviderConfig**](AzureFoundryProviderConfig.md) | [**AzureFoundryProviderConfig**](AzureFoundryProviderConfig.md) | | +[OpenAIProviderConfig](OpenAIProviderConfig.md) | [**OpenAIProviderConfig**](OpenAIProviderConfig.md) | [**OpenAIProviderConfig**](OpenAIProviderConfig.md) | | + +# models + +Models to test. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Models to test. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**LlmModel**](LlmModel.md) | [**LlmModel**](LlmModel.md) | [**LlmModel**](LlmModel.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/TestLlmProviderResponse.md b/gooddata-api-client/docs/models/TestLlmProviderResponse.md new file mode 100644 index 000000000..ad9e38e4a --- /dev/null +++ b/gooddata-api-client/docs/models/TestLlmProviderResponse.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.test_llm_provider_response.TestLlmProviderResponse + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[modelResults](#modelResults)** | list, tuple, | tuple, | Per-model test results. | +**providerReachable** | bool, | BoolClass, | Whether the LLM provider is reachable. | +**providerMessage** | str, | str, | Message about the provider connectivity test. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# modelResults + +Per-model test results. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Per-model test results. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ModelTestResult**](ModelTestResult.md) | [**ModelTestResult**](ModelTestResult.md) | [**ModelTestResult**](ModelTestResult.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/TestNotification.md b/gooddata-api-client/docs/models/TestNotification.md new file mode 100644 index 000000000..d9d271e15 --- /dev/null +++ b/gooddata-api-client/docs/models/TestNotification.md @@ -0,0 +1,29 @@ +# gooddata_api_client.model.test_notification.TestNotification + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[NotificationContent](NotificationContent.md) | [**NotificationContent**](NotificationContent.md) | [**NotificationContent**](NotificationContent.md) | | +[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_1 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**message** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Thought.md b/gooddata-api-client/docs/models/Thought.md new file mode 100644 index 000000000..ceee990c3 --- /dev/null +++ b/gooddata-api-client/docs/models/Thought.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.thought.Thought + +Detailed thoughts/messages within this step. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Detailed thoughts/messages within this step. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**text** | str, | str, | The text content of this thought. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/TriggerAutomationRequest.md b/gooddata-api-client/docs/models/TriggerAutomationRequest.md new file mode 100644 index 000000000..38e45ea5d --- /dev/null +++ b/gooddata-api-client/docs/models/TriggerAutomationRequest.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.trigger_automation_request.TriggerAutomationRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**automation** | [**AdHocAutomation**](AdHocAutomation.md) | [**AdHocAutomation**](AdHocAutomation.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/TriggerQualityIssuesCalculationResponse.md b/gooddata-api-client/docs/models/TriggerQualityIssuesCalculationResponse.md new file mode 100644 index 000000000..bc968a7d7 --- /dev/null +++ b/gooddata-api-client/docs/models/TriggerQualityIssuesCalculationResponse.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.trigger_quality_issues_calculation_response.TriggerQualityIssuesCalculationResponse + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**processId** | str, | str, | Process ID for tracking the calculation status | +**status** | str, | str, | Current status of the calculation | must be one of ["RUNNING", "COMPLETED", "FAILED", "CANCELLED", "DISABLED", ] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/UpsertKnowledgeDocumentRequestDto.md b/gooddata-api-client/docs/models/UpsertKnowledgeDocumentRequestDto.md new file mode 100644 index 000000000..6edcbf2c2 --- /dev/null +++ b/gooddata-api-client/docs/models/UpsertKnowledgeDocumentRequestDto.md @@ -0,0 +1,43 @@ +# gooddata_api_client.model.upsert_knowledge_document_request_dto.UpsertKnowledgeDocumentRequestDto + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**filename** | str, | str, | | +**content** | str, | str, | | +**[pageBoundaries](#pageBoundaries)** | list, tuple, | tuple, | | [optional] +**[scopes](#scopes)** | list, tuple, | tuple, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# pageBoundaries + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer + +# scopes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/UpsertKnowledgeDocumentResponseDto.md b/gooddata-api-client/docs/models/UpsertKnowledgeDocumentResponseDto.md new file mode 100644 index 000000000..843fc0ecc --- /dev/null +++ b/gooddata-api-client/docs/models/UpsertKnowledgeDocumentResponseDto.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.upsert_knowledge_document_response_dto.UpsertKnowledgeDocumentResponseDto + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**numChunks** | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer +**filename** | str, | str, | | +**success** | bool, | BoolClass, | | +**message** | str, | str, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/UserContext.md b/gooddata-api-client/docs/models/UserContext.md new file mode 100644 index 000000000..e89f62903 --- /dev/null +++ b/gooddata-api-client/docs/models/UserContext.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.user_context.UserContext + +User context, which can affect the behavior of the underlying AI features. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | User context, which can affect the behavior of the underlying AI features. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**activeObject** | [**ActiveObjectIdentification**](ActiveObjectIdentification.md) | [**ActiveObjectIdentification**](ActiveObjectIdentification.md) | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/UserGroupIdentifier.md b/gooddata-api-client/docs/models/UserGroupIdentifier.md new file mode 100644 index 000000000..9247ae932 --- /dev/null +++ b/gooddata-api-client/docs/models/UserGroupIdentifier.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.user_group_identifier.UserGroupIdentifier + +A list of groups where user is a member + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | A list of groups where user is a member | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**name** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/UserManagementDataSourcePermissionAssignment.md b/gooddata-api-client/docs/models/UserManagementDataSourcePermissionAssignment.md new file mode 100644 index 000000000..af8782c3a --- /dev/null +++ b/gooddata-api-client/docs/models/UserManagementDataSourcePermissionAssignment.md @@ -0,0 +1,31 @@ +# gooddata_api_client.model.user_management_data_source_permission_assignment.UserManagementDataSourcePermissionAssignment + +Datasource permission assignments for users and userGroups + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Datasource permission assignments for users and userGroups | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[permissions](#permissions)** | list, tuple, | tuple, | | +**id** | str, | str, | Id of the datasource | +**name** | str, | str, | Name of the datasource | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# permissions + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["MANAGE", "USE", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/UserManagementPermissionAssignments.md b/gooddata-api-client/docs/models/UserManagementPermissionAssignments.md new file mode 100644 index 000000000..e138bf9a8 --- /dev/null +++ b/gooddata-api-client/docs/models/UserManagementPermissionAssignments.md @@ -0,0 +1,40 @@ +# gooddata_api_client.model.user_management_permission_assignments.UserManagementPermissionAssignments + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[workspaces](#workspaces)** | list, tuple, | tuple, | | +**[dataSources](#dataSources)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dataSources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**UserManagementDataSourcePermissionAssignment**](UserManagementDataSourcePermissionAssignment.md) | [**UserManagementDataSourcePermissionAssignment**](UserManagementDataSourcePermissionAssignment.md) | [**UserManagementDataSourcePermissionAssignment**](UserManagementDataSourcePermissionAssignment.md) | | + +# workspaces + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**UserManagementWorkspacePermissionAssignment**](UserManagementWorkspacePermissionAssignment.md) | [**UserManagementWorkspacePermissionAssignment**](UserManagementWorkspacePermissionAssignment.md) | [**UserManagementWorkspacePermissionAssignment**](UserManagementWorkspacePermissionAssignment.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/UserManagementUserGroupMember.md b/gooddata-api-client/docs/models/UserManagementUserGroupMember.md new file mode 100644 index 000000000..328cdcf64 --- /dev/null +++ b/gooddata-api-client/docs/models/UserManagementUserGroupMember.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.user_management_user_group_member.UserManagementUserGroupMember + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**name** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/UserManagementUserGroupMembers.md b/gooddata-api-client/docs/models/UserManagementUserGroupMembers.md new file mode 100644 index 000000000..671b9062b --- /dev/null +++ b/gooddata-api-client/docs/models/UserManagementUserGroupMembers.md @@ -0,0 +1,27 @@ +# gooddata_api_client.model.user_management_user_group_members.UserManagementUserGroupMembers + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[members](#members)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# members + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**UserManagementUserGroupMember**](UserManagementUserGroupMember.md) | [**UserManagementUserGroupMember**](UserManagementUserGroupMember.md) | [**UserManagementUserGroupMember**](UserManagementUserGroupMember.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/UserManagementUserGroups.md b/gooddata-api-client/docs/models/UserManagementUserGroups.md new file mode 100644 index 000000000..70234ce58 --- /dev/null +++ b/gooddata-api-client/docs/models/UserManagementUserGroups.md @@ -0,0 +1,28 @@ +# gooddata_api_client.model.user_management_user_groups.UserManagementUserGroups + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[userGroups](#userGroups)** | list, tuple, | tuple, | | +**totalCount** | decimal.Decimal, int, | decimal.Decimal, | Total number of groups | value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# userGroups + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**UserManagementUserGroupsItem**](UserManagementUserGroupsItem.md) | [**UserManagementUserGroupsItem**](UserManagementUserGroupsItem.md) | [**UserManagementUserGroupsItem**](UserManagementUserGroupsItem.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/UserManagementUserGroupsItem.md b/gooddata-api-client/docs/models/UserManagementUserGroupsItem.md new file mode 100644 index 000000000..25cb66f48 --- /dev/null +++ b/gooddata-api-client/docs/models/UserManagementUserGroupsItem.md @@ -0,0 +1,46 @@ +# gooddata_api_client.model.user_management_user_groups_item.UserManagementUserGroupsItem + +List of groups + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | List of groups | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**userCount** | decimal.Decimal, int, | decimal.Decimal, | The number of users belonging to the group | value must be a 32 bit integer +**id** | str, | str, | | +**[workspaces](#workspaces)** | list, tuple, | tuple, | | +**[dataSources](#dataSources)** | list, tuple, | tuple, | | +**organizationAdmin** | bool, | BoolClass, | Is group organization admin | +**name** | str, | str, | Group name | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dataSources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**UserManagementDataSourcePermissionAssignment**](UserManagementDataSourcePermissionAssignment.md) | [**UserManagementDataSourcePermissionAssignment**](UserManagementDataSourcePermissionAssignment.md) | [**UserManagementDataSourcePermissionAssignment**](UserManagementDataSourcePermissionAssignment.md) | | + +# workspaces + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**UserManagementWorkspacePermissionAssignment**](UserManagementWorkspacePermissionAssignment.md) | [**UserManagementWorkspacePermissionAssignment**](UserManagementWorkspacePermissionAssignment.md) | [**UserManagementWorkspacePermissionAssignment**](UserManagementWorkspacePermissionAssignment.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/UserManagementUsers.md b/gooddata-api-client/docs/models/UserManagementUsers.md new file mode 100644 index 000000000..936a90b92 --- /dev/null +++ b/gooddata-api-client/docs/models/UserManagementUsers.md @@ -0,0 +1,28 @@ +# gooddata_api_client.model.user_management_users.UserManagementUsers + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**totalCount** | decimal.Decimal, int, | decimal.Decimal, | The total number of users is based on applied filters. | value must be a 32 bit integer +**[users](#users)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# users + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**UserManagementUsersItem**](UserManagementUsersItem.md) | [**UserManagementUsersItem**](UserManagementUsersItem.md) | [**UserManagementUsersItem**](UserManagementUsersItem.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/UserManagementUsersItem.md b/gooddata-api-client/docs/models/UserManagementUsersItem.md new file mode 100644 index 000000000..c7756198b --- /dev/null +++ b/gooddata-api-client/docs/models/UserManagementUsersItem.md @@ -0,0 +1,59 @@ +# gooddata_api_client.model.user_management_users_item.UserManagementUsersItem + +List of users + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | List of users | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[userGroups](#userGroups)** | list, tuple, | tuple, | | +**id** | str, | str, | | +**[workspaces](#workspaces)** | list, tuple, | tuple, | | +**[dataSources](#dataSources)** | list, tuple, | tuple, | | +**organizationAdmin** | bool, | BoolClass, | Is user organization admin | +**email** | str, | str, | User email address | [optional] +**name** | str, | str, | User name | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dataSources + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**UserManagementDataSourcePermissionAssignment**](UserManagementDataSourcePermissionAssignment.md) | [**UserManagementDataSourcePermissionAssignment**](UserManagementDataSourcePermissionAssignment.md) | [**UserManagementDataSourcePermissionAssignment**](UserManagementDataSourcePermissionAssignment.md) | | + +# userGroups + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**UserGroupIdentifier**](UserGroupIdentifier.md) | [**UserGroupIdentifier**](UserGroupIdentifier.md) | [**UserGroupIdentifier**](UserGroupIdentifier.md) | | + +# workspaces + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**UserManagementWorkspacePermissionAssignment**](UserManagementWorkspacePermissionAssignment.md) | [**UserManagementWorkspacePermissionAssignment**](UserManagementWorkspacePermissionAssignment.md) | [**UserManagementWorkspacePermissionAssignment**](UserManagementWorkspacePermissionAssignment.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/UserManagementWorkspacePermissionAssignment.md b/gooddata-api-client/docs/models/UserManagementWorkspacePermissionAssignment.md new file mode 100644 index 000000000..3da163102 --- /dev/null +++ b/gooddata-api-client/docs/models/UserManagementWorkspacePermissionAssignment.md @@ -0,0 +1,44 @@ +# gooddata_api_client.model.user_management_workspace_permission_assignment.UserManagementWorkspacePermissionAssignment + +Workspace permission assignments for users and userGroups + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Workspace permission assignments for users and userGroups | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[permissions](#permissions)** | list, tuple, | tuple, | | +**id** | str, | str, | | +**[hierarchyPermissions](#hierarchyPermissions)** | list, tuple, | tuple, | | +**name** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# hierarchyPermissions + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "WRITE_KNOWLEDGE_DOCUMENTS", "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW", ] + +# permissions + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "WRITE_KNOWLEDGE_DOCUMENTS", "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ValidateByItem.md b/gooddata-api-client/docs/models/ValidateByItem.md new file mode 100644 index 000000000..b237bd183 --- /dev/null +++ b/gooddata-api-client/docs/models/ValidateByItem.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.validate_by_item.ValidateByItem + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | Specifies entity used for valid elements computation. | +**type** | str, | str, | Specifies entity type which could be label, attribute, fact, or metric. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ValidateLLMEndpointByIdRequest.md b/gooddata-api-client/docs/models/ValidateLLMEndpointByIdRequest.md new file mode 100644 index 000000000..13c60580d --- /dev/null +++ b/gooddata-api-client/docs/models/ValidateLLMEndpointByIdRequest.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.validate_llm_endpoint_by_id_request.ValidateLLMEndpointByIdRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**baseUrl** | str, | str, | Base URL for the LLM endpoint validation | [optional] +**llmModel** | str, | str, | LLM model for the LLM endpoint validation | [optional] +**llmOrganization** | str, | str, | Organization name for the LLM endpoint validation | [optional] +**provider** | str, | str, | Provider for the LLM endpoint validation | [optional] +**token** | str, | str, | Token for the LLM endpoint validation | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ValidateLLMEndpointRequest.md b/gooddata-api-client/docs/models/ValidateLLMEndpointRequest.md new file mode 100644 index 000000000..0b7ed15a9 --- /dev/null +++ b/gooddata-api-client/docs/models/ValidateLLMEndpointRequest.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.validate_llm_endpoint_request.ValidateLLMEndpointRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**provider** | str, | str, | Provider for the LLM endpoint validation | +**token** | str, | str, | Token for the LLM endpoint validation | +**baseUrl** | str, | str, | Base URL for the LLM endpoint validation | [optional] +**llmModel** | str, | str, | LLM model for the LLM endpoint validation | [optional] +**llmOrganization** | str, | str, | Organization name for the LLM endpoint validation | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/ValidateLLMEndpointResponse.md b/gooddata-api-client/docs/models/ValidateLLMEndpointResponse.md new file mode 100644 index 000000000..5dd3f2bdb --- /dev/null +++ b/gooddata-api-client/docs/models/ValidateLLMEndpointResponse.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.validate_llm_endpoint_response.ValidateLLMEndpointResponse + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**message** | str, | str, | Additional message about the LLM endpoint validation | +**successful** | bool, | BoolClass, | Whether the LLM endpoint validation was successful | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Value.md b/gooddata-api-client/docs/models/Value.md new file mode 100644 index 000000000..8a32d2d95 --- /dev/null +++ b/gooddata-api-client/docs/models/Value.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.value.Value + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**value** | decimal.Decimal, int, float, | decimal.Decimal, | Value of the alert threshold to compare the metric to. | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/VisibleFilter.md b/gooddata-api-client/docs/models/VisibleFilter.md new file mode 100644 index 000000000..536b55da0 --- /dev/null +++ b/gooddata-api-client/docs/models/VisibleFilter.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.visible_filter.VisibleFilter + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**isAllTimeDateFilter** | bool, | BoolClass, | 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. | [optional] if omitted the server will use the default value of False +**localIdentifier** | str, | str, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/VisualExportRequest.md b/gooddata-api-client/docs/models/VisualExportRequest.md new file mode 100644 index 000000000..7e71bc910 --- /dev/null +++ b/gooddata-api-client/docs/models/VisualExportRequest.md @@ -0,0 +1,28 @@ +# gooddata_api_client.model.visual_export_request.VisualExportRequest + +Export request object describing the export properties and metadata for dashboard PDF exports. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Export request object describing the export properties and metadata for dashboard PDF exports. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**fileName** | str, | str, | File name to be used for retrieving the pdf document. | +**dashboardId** | str, | str, | Dashboard identifier | +**[metadata](#metadata)** | dict, frozendict.frozendict, | frozendict.frozendict, | Metadata definition in free-form JSON format. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# metadata + +Metadata definition in free-form JSON format. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Metadata definition in free-form JSON format. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/VisualizationConfig.md b/gooddata-api-client/docs/models/VisualizationConfig.md new file mode 100644 index 000000000..20d5e5b01 --- /dev/null +++ b/gooddata-api-client/docs/models/VisualizationConfig.md @@ -0,0 +1,20 @@ +# gooddata_api_client.model.visualization_config.VisualizationConfig + +Visualization config for smart-function rendering. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Visualization config for smart-function rendering. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**anomalyDetection** | [**AnomalyDetectionConfig**](AnomalyDetectionConfig.md) | [**AnomalyDetectionConfig**](AnomalyDetectionConfig.md) | | [optional] +**clustering** | [**ClusteringConfig**](ClusteringConfig.md) | [**ClusteringConfig**](ClusteringConfig.md) | | [optional] +**forecast** | [**ForecastConfig**](ForecastConfig.md) | [**ForecastConfig**](ForecastConfig.md) | | [optional] +**whatIf** | [**WhatIfScenarioConfig**](WhatIfScenarioConfig.md) | [**WhatIfScenarioConfig**](WhatIfScenarioConfig.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Webhook.md b/gooddata-api-client/docs/models/Webhook.md new file mode 100644 index 000000000..f76fa77f7 --- /dev/null +++ b/gooddata-api-client/docs/models/Webhook.md @@ -0,0 +1,46 @@ +# gooddata_api_client.model.webhook.Webhook + +Webhook destination for notifications. The property url is required on create and update. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Webhook destination for notifications. The property url is required on create and update. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**type** | str, | str, | The destination type. | must be one of ["WEBHOOK", ] +**hasSecretKey** | None, bool, | NoneClass, BoolClass, | Flag indicating if webhook has a hmac secret key. | [optional] +**hasToken** | None, bool, | NoneClass, BoolClass, | Flag indicating if webhook has a token. | [optional] +**secretKey** | None, str, | NoneClass, str, | Hmac secret key for the webhook signature. | [optional] +**token** | None, str, | NoneClass, str, | Bearer token for the webhook. | [optional] +**url** | str, | str, | The webhook URL. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +### Composed Schemas (allOf/anyOf/oneOf/not) +#### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[all_of_0](#all_of_0) | dict, frozendict.frozendict, | frozendict.frozendict, | | + +# all_of_0 + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**hasSecretKey** | None, bool, | NoneClass, BoolClass, | Flag indicating if webhook has a hmac secret key. | [optional] +**hasToken** | None, bool, | NoneClass, BoolClass, | Flag indicating if webhook has a token. | [optional] +**secretKey** | None, str, | NoneClass, str, | Hmac secret key for the webhook signature. | [optional] +**token** | None, str, | NoneClass, str, | Bearer token for the webhook. | [optional] +**type** | str, | str, | The destination type. | [optional] must be one of ["WEBHOOK", ] +**url** | str, | str, | The webhook URL. | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/WebhookAutomationInfo.md b/gooddata-api-client/docs/models/WebhookAutomationInfo.md new file mode 100644 index 000000000..93e25ba86 --- /dev/null +++ b/gooddata-api-client/docs/models/WebhookAutomationInfo.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.webhook_automation_info.WebhookAutomationInfo + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**isCustomDashboardURL** | bool, | BoolClass, | | +**dashboardURL** | str, | str, | | +**id** | str, | str, | | +**dashboardTitle** | str, | str, | | [optional] +**title** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/WebhookMessage.md b/gooddata-api-client/docs/models/WebhookMessage.md new file mode 100644 index 000000000..7df2d516e --- /dev/null +++ b/gooddata-api-client/docs/models/WebhookMessage.md @@ -0,0 +1,17 @@ +# gooddata_api_client.model.webhook_message.WebhookMessage + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**data** | [**WebhookMessageData**](WebhookMessageData.md) | [**WebhookMessageData**](WebhookMessageData.md) | | +**type** | str, | str, | | must be one of ["automation-task.completed", "automation-task.limit-exceeded", ] +**timestamp** | str, datetime, | str, | | value must conform to RFC-3339 date-time +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/WebhookMessageData.md b/gooddata-api-client/docs/models/WebhookMessageData.md new file mode 100644 index 000000000..834a67a94 --- /dev/null +++ b/gooddata-api-client/docs/models/WebhookMessageData.md @@ -0,0 +1,135 @@ +# gooddata_api_client.model.webhook_message_data.WebhookMessageData + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**automation** | [**WebhookAutomationInfo**](WebhookAutomationInfo.md) | [**WebhookAutomationInfo**](WebhookAutomationInfo.md) | | +**alert** | [**AlertDescription**](AlertDescription.md) | [**AlertDescription**](AlertDescription.md) | | [optional] +**[dashboardTabularExports](#dashboardTabularExports)** | list, tuple, | tuple, | | [optional] +**[details](#details)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**[filters](#filters)** | list, tuple, | tuple, | | [optional] +**[imageExports](#imageExports)** | list, tuple, | tuple, | | [optional] +**notificationSource** | str, | str, | | [optional] +**[rawExports](#rawExports)** | list, tuple, | tuple, | | [optional] +**[recipients](#recipients)** | list, tuple, | tuple, | | [optional] +**remainingActionCount** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer +**[slidesExports](#slidesExports)** | list, tuple, | tuple, | | [optional] +**[tabularExports](#tabularExports)** | list, tuple, | tuple, | | [optional] +**[visualExports](#visualExports)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# dashboardTabularExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ExportResult**](ExportResult.md) | [**ExportResult**](ExportResult.md) | [**ExportResult**](ExportResult.md) | | + +# details + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional] + +# filters + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**NotificationFilter**](NotificationFilter.md) | [**NotificationFilter**](NotificationFilter.md) | [**NotificationFilter**](NotificationFilter.md) | | + +# imageExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ExportResult**](ExportResult.md) | [**ExportResult**](ExportResult.md) | [**ExportResult**](ExportResult.md) | | + +# rawExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ExportResult**](ExportResult.md) | [**ExportResult**](ExportResult.md) | [**ExportResult**](ExportResult.md) | | + +# recipients + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**WebhookRecipient**](WebhookRecipient.md) | [**WebhookRecipient**](WebhookRecipient.md) | [**WebhookRecipient**](WebhookRecipient.md) | | + +# slidesExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ExportResult**](ExportResult.md) | [**ExportResult**](ExportResult.md) | [**ExportResult**](ExportResult.md) | | + +# tabularExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ExportResult**](ExportResult.md) | [**ExportResult**](ExportResult.md) | [**ExportResult**](ExportResult.md) | | + +# visualExports + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**ExportResult**](ExportResult.md) | [**ExportResult**](ExportResult.md) | [**ExportResult**](ExportResult.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/WebhookRecipient.md b/gooddata-api-client/docs/models/WebhookRecipient.md new file mode 100644 index 000000000..f7bc353ce --- /dev/null +++ b/gooddata-api-client/docs/models/WebhookRecipient.md @@ -0,0 +1,16 @@ +# gooddata_api_client.model.webhook_recipient.WebhookRecipient + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**email** | str, | str, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/WhatIfMeasureAdjustmentConfig.md b/gooddata-api-client/docs/models/WhatIfMeasureAdjustmentConfig.md new file mode 100644 index 000000000..e097b756e --- /dev/null +++ b/gooddata-api-client/docs/models/WhatIfMeasureAdjustmentConfig.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.what_if_measure_adjustment_config.WhatIfMeasureAdjustmentConfig + +Measure adjustments for this scenario + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Measure adjustments for this scenario | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**metricType** | str, | str, | Type: metric or fact | +**metricId** | str, | str, | ID of the metric or fact to adjust | +**scenarioMaql** | str, | str, | Alternative MAQL expression for this scenario | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/WhatIfScenarioConfig.md b/gooddata-api-client/docs/models/WhatIfScenarioConfig.md new file mode 100644 index 000000000..f272e543d --- /dev/null +++ b/gooddata-api-client/docs/models/WhatIfScenarioConfig.md @@ -0,0 +1,32 @@ +# gooddata_api_client.model.what_if_scenario_config.WhatIfScenarioConfig + +What-if scenario configuration. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | What-if scenario configuration. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**includeBaseline** | bool, | BoolClass, | Whether baseline (unmodified) values are included | +**[scenarios](#scenarios)** | list, tuple, | tuple, | Scenarios with alternative measure calculations | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# scenarios + +Scenarios with alternative measure calculations + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Scenarios with alternative measure calculations | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**WhatIfScenarioItem**](WhatIfScenarioItem.md) | [**WhatIfScenarioItem**](WhatIfScenarioItem.md) | [**WhatIfScenarioItem**](WhatIfScenarioItem.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/WhatIfScenarioItem.md b/gooddata-api-client/docs/models/WhatIfScenarioItem.md new file mode 100644 index 000000000..2447d59c3 --- /dev/null +++ b/gooddata-api-client/docs/models/WhatIfScenarioItem.md @@ -0,0 +1,32 @@ +# gooddata_api_client.model.what_if_scenario_item.WhatIfScenarioItem + +Scenarios with alternative measure calculations + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Scenarios with alternative measure calculations | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[adjustments](#adjustments)** | list, tuple, | tuple, | Measure adjustments for this scenario | +**label** | str, | str, | Human-readable scenario label | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# adjustments + +Measure adjustments for this scenario + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Measure adjustments for this scenario | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**WhatIfMeasureAdjustmentConfig**](WhatIfMeasureAdjustmentConfig.md) | [**WhatIfMeasureAdjustmentConfig**](WhatIfMeasureAdjustmentConfig.md) | [**WhatIfMeasureAdjustmentConfig**](WhatIfMeasureAdjustmentConfig.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/WidgetSlidesTemplate.md b/gooddata-api-client/docs/models/WidgetSlidesTemplate.md new file mode 100644 index 000000000..0216e4bbb --- /dev/null +++ b/gooddata-api-client/docs/models/WidgetSlidesTemplate.md @@ -0,0 +1,32 @@ +# gooddata_api_client.model.widget_slides_template.WidgetSlidesTemplate + +Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | Template for widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[appliedOn](#appliedOn)** | list, tuple, | tuple, | Export types this template applies to. | +**contentSlide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# appliedOn + +Export types this template applies to. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | Export types this template applies to. | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["PDF", "PPTX", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/WorkspaceAutomationIdentifier.md b/gooddata-api-client/docs/models/WorkspaceAutomationIdentifier.md new file mode 100644 index 000000000..9790a6970 --- /dev/null +++ b/gooddata-api-client/docs/models/WorkspaceAutomationIdentifier.md @@ -0,0 +1,15 @@ +# gooddata_api_client.model.workspace_automation_identifier.WorkspaceAutomationIdentifier + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/WorkspaceAutomationManagementBulkRequest.md b/gooddata-api-client/docs/models/WorkspaceAutomationManagementBulkRequest.md new file mode 100644 index 000000000..ade3dc4c7 --- /dev/null +++ b/gooddata-api-client/docs/models/WorkspaceAutomationManagementBulkRequest.md @@ -0,0 +1,27 @@ +# gooddata_api_client.model.workspace_automation_management_bulk_request.WorkspaceAutomationManagementBulkRequest + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[automations](#automations)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# automations + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**WorkspaceAutomationIdentifier**](WorkspaceAutomationIdentifier.md) | [**WorkspaceAutomationIdentifier**](WorkspaceAutomationIdentifier.md) | [**WorkspaceAutomationIdentifier**](WorkspaceAutomationIdentifier.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/WorkspaceDataSource.md b/gooddata-api-client/docs/models/WorkspaceDataSource.md new file mode 100644 index 000000000..035b45b1b --- /dev/null +++ b/gooddata-api-client/docs/models/WorkspaceDataSource.md @@ -0,0 +1,32 @@ +# gooddata_api_client.model.workspace_data_source.WorkspaceDataSource + +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. + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | 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. | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | The ID of the used data source. | +**[schemaPath](#schemaPath)** | list, tuple, | tuple, | The full schema path as array of its path parts. Will be rendered as subPath1.subPath2... | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# schemaPath + +The full schema path as array of its path parts. Will be rendered as subPath1.subPath2... + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | The full schema path as array of its path parts. Will be rendered as subPath1.subPath2... | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | The part of the schema path. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/WorkspacePermissionAssignment.md b/gooddata-api-client/docs/models/WorkspacePermissionAssignment.md new file mode 100644 index 000000000..f459d8e31 --- /dev/null +++ b/gooddata-api-client/docs/models/WorkspacePermissionAssignment.md @@ -0,0 +1,43 @@ +# gooddata_api_client.model.workspace_permission_assignment.WorkspacePermissionAssignment + +Workspace permission assignments + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | Workspace permission assignments | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**assigneeIdentifier** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | +**[hierarchyPermissions](#hierarchyPermissions)** | list, tuple, | tuple, | | [optional] +**[permissions](#permissions)** | list, tuple, | tuple, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# hierarchyPermissions + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "WRITE_KNOWLEDGE_DOCUMENTS", "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW", ] + +# permissions + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str, | str, | | must be one of ["MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "WRITE_KNOWLEDGE_DOCUMENTS", "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/WorkspaceUser.md b/gooddata-api-client/docs/models/WorkspaceUser.md new file mode 100644 index 000000000..98d4bf2ec --- /dev/null +++ b/gooddata-api-client/docs/models/WorkspaceUser.md @@ -0,0 +1,19 @@ +# gooddata_api_client.model.workspace_user.WorkspaceUser + +List of workspace users + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | List of workspace users | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**email** | str, | str, | User email address | [optional] +**name** | str, | str, | User name | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/WorkspaceUserGroup.md b/gooddata-api-client/docs/models/WorkspaceUserGroup.md new file mode 100644 index 000000000..c32ab3d9a --- /dev/null +++ b/gooddata-api-client/docs/models/WorkspaceUserGroup.md @@ -0,0 +1,18 @@ +# gooddata_api_client.model.workspace_user_group.WorkspaceUserGroup + +List of workspace groups + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | List of workspace groups | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**id** | str, | str, | | +**name** | str, | str, | Group name | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/WorkspaceUserGroups.md b/gooddata-api-client/docs/models/WorkspaceUserGroups.md new file mode 100644 index 000000000..60f81045e --- /dev/null +++ b/gooddata-api-client/docs/models/WorkspaceUserGroups.md @@ -0,0 +1,28 @@ +# gooddata_api_client.model.workspace_user_groups.WorkspaceUserGroups + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[userGroups](#userGroups)** | list, tuple, | tuple, | | +**totalCount** | decimal.Decimal, int, | decimal.Decimal, | Total number of groups | value must be a 32 bit integer +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# userGroups + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**WorkspaceUserGroup**](WorkspaceUserGroup.md) | [**WorkspaceUserGroup**](WorkspaceUserGroup.md) | [**WorkspaceUserGroup**](WorkspaceUserGroup.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/WorkspaceUsers.md b/gooddata-api-client/docs/models/WorkspaceUsers.md new file mode 100644 index 000000000..b4011f901 --- /dev/null +++ b/gooddata-api-client/docs/models/WorkspaceUsers.md @@ -0,0 +1,28 @@ +# gooddata_api_client.model.workspace_users.WorkspaceUsers + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**totalCount** | decimal.Decimal, int, | decimal.Decimal, | The total number of users is based on applied filters. | value must be a 32 bit integer +**[users](#users)** | list, tuple, | tuple, | | +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# users + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**WorkspaceUser**](WorkspaceUser.md) | [**WorkspaceUser**](WorkspaceUser.md) | [**WorkspaceUser**](WorkspaceUser.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/gooddata-api-client/docs/models/Xliff.md b/gooddata-api-client/docs/models/Xliff.md new file mode 100644 index 000000000..835f9b551 --- /dev/null +++ b/gooddata-api-client/docs/models/Xliff.md @@ -0,0 +1,44 @@ +# gooddata_api_client.model.xliff.Xliff + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**[file](#file)** | list, tuple, | tuple, | | [optional] +**[otherAttributes](#otherAttributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] +**space** | str, | str, | | [optional] +**srcLang** | str, | str, | | [optional] +**trgLang** | str, | str, | | [optional] +**version** | str, | str, | | [optional] +**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] + +# file + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple, | tuple, | | + +### Tuple Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[**File**](File.md) | [**File**](File.md) | [**File**](File.md) | | + +# otherAttributes + +## Model Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, | frozendict.frozendict, | | + +### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + 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 a64e922f4..a578be876 100644 --- a/gooddata-api-client/gooddata_api_client/api/actions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/actions_api.py @@ -48,11 +48,14 @@ 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.create_knowledge_document_request_dto import CreateKnowledgeDocumentRequestDto +from gooddata_api_client.model.create_knowledge_document_response_dto import CreateKnowledgeDocumentResponseDto from gooddata_api_client.model.dashboard_permissions import DashboardPermissions from gooddata_api_client.model.dashboard_tabular_export_request import DashboardTabularExportRequest from gooddata_api_client.model.data_source_permission_assignment import DataSourcePermissionAssignment from gooddata_api_client.model.data_source_schemata import DataSourceSchemata from gooddata_api_client.model.declarative_model import DeclarativeModel +from gooddata_api_client.model.delete_knowledge_document_response_dto import DeleteKnowledgeDocumentResponseDto from gooddata_api_client.model.dependent_entities_request import DependentEntitiesRequest from gooddata_api_client.model.dependent_entities_response import DependentEntitiesResponse from gooddata_api_client.model.elements_request import ElementsRequest @@ -62,7 +65,11 @@ from gooddata_api_client.model.export_response import ExportResponse from gooddata_api_client.model.forecast_request import ForecastRequest from gooddata_api_client.model.forecast_result import ForecastResult +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 +from gooddata_api_client.model.generate_title_request import GenerateTitleRequest +from gooddata_api_client.model.generate_title_response import GenerateTitleResponse from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse from gooddata_api_client.model.hierarchy_object_identification import HierarchyObjectIdentification @@ -71,6 +78,8 @@ from gooddata_api_client.model.key_drivers_request import KeyDriversRequest from gooddata_api_client.model.key_drivers_response import KeyDriversResponse from gooddata_api_client.model.key_drivers_result import KeyDriversResult +from gooddata_api_client.model.knowledge_document_metadata_dto import KnowledgeDocumentMetadataDto +from gooddata_api_client.model.list_knowledge_documents_response_dto import ListKnowledgeDocumentsResponseDto from gooddata_api_client.model.locale_request import LocaleRequest from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner from gooddata_api_client.model.memory_item_created_by_users import MemoryItemCreatedByUsers @@ -80,6 +89,7 @@ from gooddata_api_client.model.outlier_detection_request import OutlierDetectionRequest from gooddata_api_client.model.outlier_detection_response import OutlierDetectionResponse from gooddata_api_client.model.outlier_detection_result import OutlierDetectionResult +from gooddata_api_client.model.patch_knowledge_document_request_dto import PatchKnowledgeDocumentRequestDto from gooddata_api_client.model.platform_usage import PlatformUsage from gooddata_api_client.model.platform_usage_request import PlatformUsageRequest from gooddata_api_client.model.quality_issues_calculation_status_response import QualityIssuesCalculationStatusResponse @@ -92,18 +102,24 @@ 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_knowledge_response_dto import SearchKnowledgeResponseDto 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 from gooddata_api_client.model.switch_identity_provider_request import SwitchIdentityProviderRequest from gooddata_api_client.model.tabular_export_request import TabularExportRequest from gooddata_api_client.model.test_definition_request import TestDefinitionRequest from gooddata_api_client.model.test_destination_request import TestDestinationRequest +from gooddata_api_client.model.test_llm_provider_definition_request import TestLlmProviderDefinitionRequest +from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse from gooddata_api_client.model.test_request import TestRequest from gooddata_api_client.model.test_response import TestResponse 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.upsert_knowledge_document_request_dto import UpsertKnowledgeDocumentRequestDto +from gooddata_api_client.model.upsert_knowledge_document_response_dto import UpsertKnowledgeDocumentResponseDto from gooddata_api_client.model.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest from gooddata_api_client.model.validate_llm_endpoint_request import ValidateLLMEndpointRequest from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse @@ -1528,6 +1544,69 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.create_document_endpoint = _Endpoint( + settings={ + 'response_type': (CreateKnowledgeDocumentResponseDto,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents', + 'operation_id': 'create_document', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'create_knowledge_document_request_dto', + ], + 'required': [ + 'workspace_id', + 'create_knowledge_document_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,), + 'create_knowledge_document_request_dto': + (CreateKnowledgeDocumentRequestDto,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'create_knowledge_document_request_dto': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.create_image_export_endpoint = _Endpoint( settings={ 'response_type': (ExportResponse,), @@ -1929,6 +2008,68 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.delete_document_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteKnowledgeDocumentResponseDto,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents/{filename}', + 'operation_id': 'delete_document', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'filename', + ], + 'required': [ + 'workspace_id', + 'filename', + ], + '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,), + 'filename': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'filename': 'filename', + }, + 'location_map': { + 'workspace_id': 'path', + 'filename': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.delete_organization_automations_endpoint = _Endpoint( settings={ 'response_type': None, @@ -2263,6 +2404,69 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.generate_description_endpoint = _Endpoint( + settings={ + 'response_type': (GenerateDescriptionResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateDescription', + 'operation_id': 'generate_description', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'generate_description_request', + ], + 'required': [ + 'workspace_id', + 'generate_description_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,), + 'generate_description_request': + (GenerateDescriptionRequest,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'generate_description_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.generate_logical_model_endpoint = _Endpoint( settings={ 'response_type': (DeclarativeModel,), @@ -2375,6 +2579,69 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.generate_title_endpoint = _Endpoint( + settings={ + 'response_type': (GenerateTitleResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateTitle', + 'operation_id': 'generate_title', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'generate_title_request', + ], + 'required': [ + 'workspace_id', + 'generate_title_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,), + 'generate_title_request': + (GenerateTitleRequest,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'generate_title_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.get_data_source_schemata_endpoint = _Endpoint( settings={ 'response_type': (DataSourceSchemata,), @@ -2536,68 +2803,74 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_exported_file_endpoint = _Endpoint( + self.get_document_endpoint = _Endpoint( settings={ - 'response_type': (file_type,), + 'response_type': (KnowledgeDocumentMetadataDto,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}', - 'operation_id': 'get_exported_file', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents/{filename}', + 'operation_id': 'get_document', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'export_id', + 'filename', ], 'required': [ 'workspace_id', - 'export_id', + 'filename', ], '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,), - 'export_id': + 'filename': (str,), }, 'attribute_map': { 'workspace_id': 'workspaceId', - 'export_id': 'exportId', + 'filename': 'filename', }, 'location_map': { 'workspace_id': 'path', - 'export_id': 'path', + 'filename': 'path', }, 'collection_format_map': { } }, headers_map={ 'accept': [ - 'application/pdf', - 'application/zip' + 'application/json' ], 'content_type': [], }, api_client=api_client ) - self.get_image_export_endpoint = _Endpoint( + self.get_exported_file_endpoint = _Endpoint( settings={ 'response_type': (file_type,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}', - 'operation_id': 'get_image_export', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}', + 'operation_id': 'get_exported_file', 'http_method': 'GET', 'servers': None, }, @@ -2641,18 +2914,19 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'image/png' + 'application/pdf', + 'application/zip' ], 'content_type': [], }, api_client=api_client ) - self.get_image_export_metadata_endpoint = _Endpoint( + self.get_image_export_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (file_type,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata', - 'operation_id': 'get_image_export_metadata', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}', + 'operation_id': 'get_image_export', 'http_method': 'GET', 'servers': None, }, @@ -2696,17 +2970,72 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'application/json' + 'image/png' ], 'content_type': [], }, api_client=api_client ) - self.get_metadata_endpoint = _Endpoint( + self.get_image_export_metadata_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata', + 'operation_id': 'get_image_export_metadata', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'export_id', + ], + 'required': [ + 'workspace_id', + 'export_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'export_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'export_id': 'exportId', + }, + 'location_map': { + 'workspace_id': 'path', + 'export_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_metadata_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata', 'operation_id': 'get_metadata', 'http_method': 'GET', 'servers': None, @@ -3476,6 +3805,83 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.list_documents_endpoint = _Endpoint( + settings={ + 'response_type': (ListKnowledgeDocumentsResponseDto,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents', + 'operation_id': 'list_documents', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'scopes', + 'size', + 'page_token', + 'meta_include', + ], + '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,), + 'scopes': + ([str],), + 'size': + (int,), + 'page_token': + (str,), + 'meta_include': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'scopes': 'scopes', + 'size': 'size', + 'page_token': 'pageToken', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'scopes': 'query', + 'size': 'query', + 'page_token': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'scopes': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.list_workspace_user_groups_endpoint = _Endpoint( settings={ 'response_type': (WorkspaceUserGroups,), @@ -4334,6 +4740,75 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.patch_document_endpoint = _Endpoint( + settings={ + 'response_type': (KnowledgeDocumentMetadataDto,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents/{filename}', + 'operation_id': 'patch_document', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'filename', + 'patch_knowledge_document_request_dto', + ], + 'required': [ + 'workspace_id', + 'filename', + 'patch_knowledge_document_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,), + 'filename': + (str,), + 'patch_knowledge_document_request_dto': + (PatchKnowledgeDocumentRequestDto,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'filename': 'filename', + }, + 'location_map': { + 'workspace_id': 'path', + 'filename': 'path', + 'patch_knowledge_document_request_dto': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.pause_organization_automations_endpoint = _Endpoint( settings={ 'response_type': None, @@ -5062,75 +5537,101 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.set_translations_endpoint = _Endpoint( + self.search_knowledge_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (SearchKnowledgeResponseDto,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/translations/set', - 'operation_id': 'set_translations', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/knowledge/search', + 'operation_id': 'search_knowledge', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'xliff', + 'query', + 'limit', + 'min_score', + 'scopes', ], 'required': [ 'workspace_id', - 'xliff', + 'query', ], '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,), - 'xliff': - (Xliff,), + 'query': + (str,), + 'limit': + (int,), + 'min_score': + (float,), + 'scopes': + ([str],), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'query': 'query', + 'limit': 'limit', + 'min_score': 'minScore', + 'scopes': 'scopes', }, 'location_map': { 'workspace_id': 'path', - 'xliff': 'body', + 'query': 'query', + 'limit': 'query', + 'min_score': 'query', + 'scopes': 'query', }, 'collection_format_map': { + 'scopes': 'multi', } }, headers_map={ - 'accept': [], - 'content_type': [ - 'application/xml' - ] + 'accept': [ + 'application/json' + ], + 'content_type': [], }, api_client=api_client ) - self.switch_active_identity_provider_endpoint = _Endpoint( + self.set_certification_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/switchActiveIdentityProvider', - 'operation_id': 'switch_active_identity_provider', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/setCertification', + 'operation_id': 'set_certification', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ - 'switch_identity_provider_request', + 'workspace_id', + 'set_certification_request', ], 'required': [ - 'switch_identity_provider_request', + 'workspace_id', + 'set_certification_request', ], 'nullable': [ ], @@ -5145,13 +5646,17 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { - 'switch_identity_provider_request': - (SwitchIdentityProviderRequest,), + 'workspace_id': + (str,), + 'set_certification_request': + (SetCertificationRequest,), }, 'attribute_map': { + 'workspace_id': 'workspaceId', }, 'location_map': { - 'switch_identity_provider_request': 'body', + 'workspace_id': 'path', + 'set_certification_request': 'body', }, 'collection_format_map': { } @@ -5164,67 +5669,169 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.tags_endpoint = _Endpoint( + self.set_translations_endpoint = _Endpoint( settings={ - 'response_type': (AnalyticsCatalogTags,), + 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags', - 'operation_id': 'tags', - 'http_method': 'GET', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/translations/set', + 'operation_id': 'set_translations', + 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'workspace_id', + 'xliff', ], 'required': [ 'workspace_id', + 'xliff', ], '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,), + 'xliff': + (Xliff,), }, 'attribute_map': { 'workspace_id': 'workspaceId', }, 'location_map': { 'workspace_id': 'path', + 'xliff': 'body', }, 'collection_format_map': { } }, headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], + 'accept': [], + 'content_type': [ + 'application/xml' + ] }, api_client=api_client ) - self.test_data_source_endpoint = _Endpoint( + self.switch_active_identity_provider_endpoint = _Endpoint( settings={ - 'response_type': (TestResponse,), + 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/test', + 'endpoint_path': '/api/v1/actions/organization/switchActiveIdentityProvider', + 'operation_id': 'switch_active_identity_provider', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'switch_identity_provider_request', + ], + 'required': [ + 'switch_identity_provider_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'switch_identity_provider_request': + (SwitchIdentityProviderRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'switch_identity_provider_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.tags_endpoint = _Endpoint( + settings={ + 'response_type': (AnalyticsCatalogTags,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags', + 'operation_id': 'tags', + '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.test_data_source_endpoint = _Endpoint( + settings={ + 'response_type': (TestResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/test', 'operation_id': 'test_data_source', 'http_method': 'POST', 'servers': None, @@ -5388,6 +5995,105 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.test_llm_provider_endpoint = _Endpoint( + settings={ + 'response_type': (TestLlmProviderResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/ai/llmProvider/test', + 'operation_id': 'test_llm_provider', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'test_llm_provider_definition_request', + ], + 'required': [ + 'test_llm_provider_definition_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'test_llm_provider_definition_request': + (TestLlmProviderDefinitionRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'test_llm_provider_definition_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.test_llm_provider_by_id_endpoint = _Endpoint( + settings={ + 'response_type': (TestLlmProviderResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/ai/llmProvider/{llmProviderId}/test', + 'operation_id': 'test_llm_provider_by_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'llm_provider_id', + ], + 'required': [ + 'llm_provider_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'llm_provider_id': + (str,), + }, + 'attribute_map': { + 'llm_provider_id': 'llmProviderId', + }, + 'location_map': { + 'llm_provider_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.test_notification_channel_endpoint = _Endpoint( settings={ 'response_type': (TestResponse,), @@ -5945,6 +6651,69 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.upsert_document_endpoint = _Endpoint( + settings={ + 'response_type': (UpsertKnowledgeDocumentResponseDto,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents', + 'operation_id': 'upsert_document', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'upsert_knowledge_document_request_dto', + ], + 'required': [ + 'workspace_id', + 'upsert_knowledge_document_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,), + 'upsert_knowledge_document_request_dto': + (UpsertKnowledgeDocumentRequestDto,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'upsert_knowledge_document_request_dto': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.validate_llm_endpoint_endpoint = _Endpoint( settings={ 'response_type': (ValidateLLMEndpointResponse,), @@ -8089,24 +8858,23 @@ def create_dashboard_export_request( dashboard_tabular_export_request return self.create_dashboard_export_request_endpoint.call_with_http_info(**kwargs) - def create_image_export( + def create_document( self, workspace_id, - image_export_request, + create_knowledge_document_request_dto, **kwargs ): - """(EXPERIMENTAL) Create image export request # noqa: E501 + """create_document # noqa: E501 - Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_image_export(workspace_id, image_export_request, async_req=True) + >>> thread = api.create_document(workspace_id, create_knowledge_document_request_dto, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - image_export_request (ImageExportRequest): + workspace_id (str): Workspace identifier + create_knowledge_document_request_dto (CreateKnowledgeDocumentRequestDto): Keyword Args: _return_http_data_only (bool): response data without head status @@ -8141,7 +8909,7 @@ def create_image_export( async_req (bool): execute request asynchronously Returns: - ExportResponse + CreateKnowledgeDocumentResponseDto If the method is called asynchronously, returns the request thread. """ @@ -8172,17 +8940,104 @@ def create_image_export( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['image_export_request'] = \ - image_export_request - return self.create_image_export_endpoint.call_with_http_info(**kwargs) + kwargs['create_knowledge_document_request_dto'] = \ + create_knowledge_document_request_dto + return self.create_document_endpoint.call_with_http_info(**kwargs) - def create_pdf_export( + def create_image_export( self, workspace_id, - visual_export_request, + image_export_request, **kwargs ): - """Create visual - pdf export request # noqa: E501 + """(EXPERIMENTAL) Create image export request # noqa: E501 + + Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_image_export(workspace_id, image_export_request, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + image_export_request (ImageExportRequest): + + 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: + ExportResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['image_export_request'] = \ + image_export_request + return self.create_image_export_endpoint.call_with_http_info(**kwargs) + + def create_pdf_export( + self, + workspace_id, + visual_export_request, + **kwargs + ): + """Create visual - pdf export request # noqa: E501 An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -8695,6 +9550,92 @@ def dashboard_permissions( dashboard_id return self.dashboard_permissions_endpoint.call_with_http_info(**kwargs) + def delete_document( + self, + workspace_id, + filename, + **kwargs + ): + """delete_document # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_document(workspace_id, filename, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): Workspace identifier + filename (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: + DeleteKnowledgeDocumentResponseDto + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', 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['filename'] = \ + filename + return self.delete_document_endpoint.call_with_http_info(**kwargs) + def delete_organization_automations( self, organization_automation_management_bulk_request, @@ -9132,24 +10073,24 @@ def forecast_result( result_id return self.forecast_result_endpoint.call_with_http_info(**kwargs) - def generate_logical_model( + def generate_description( self, - data_source_id, - generate_ldm_request, + workspace_id, + generate_description_request, **kwargs ): - """Generate logical data model (LDM) from physical data model (PDM) # noqa: E501 + """Generate Description for Analytics Object # noqa: E501 - Generate logical data model (LDM) from physical data model (PDM) stored in data source. # noqa: E501 + Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed. # 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_logical_model(data_source_id, generate_ldm_request, async_req=True) + >>> thread = api.generate_description(workspace_id, generate_description_request, async_req=True) >>> result = thread.get() Args: - data_source_id (str): - generate_ldm_request (GenerateLdmRequest): + workspace_id (str): Workspace identifier + generate_description_request (GenerateDescriptionRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -9184,7 +10125,7 @@ def generate_logical_model( async_req (bool): execute request asynchronously Returns: - DeclarativeModel + GenerateDescriptionResponse If the method is called asynchronously, returns the request thread. """ @@ -9213,25 +10154,25 @@ def generate_logical_model( '_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['generate_ldm_request'] = \ - generate_ldm_request - return self.generate_logical_model_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['generate_description_request'] = \ + generate_description_request + return self.generate_description_endpoint.call_with_http_info(**kwargs) - def generate_logical_model_aac( + def generate_logical_model( self, data_source_id, generate_ldm_request, **kwargs ): - """Generate logical data model in AAC format from physical data model (PDM) # noqa: E501 + """Generate logical data model (LDM) from physical data model (PDM) # noqa: E501 - Generate logical data model (LDM) from physical data model (PDM) stored in data source, returning the result in Analytics as Code (AAC) format compatible with the GoodData VSCode extension YAML definitions. # noqa: E501 + Generate logical data model (LDM) from physical data model (PDM) stored in 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.generate_logical_model_aac(data_source_id, generate_ldm_request, async_req=True) + >>> thread = api.generate_logical_model(data_source_id, generate_ldm_request, async_req=True) >>> result = thread.get() Args: @@ -9271,7 +10212,7 @@ def generate_logical_model_aac( async_req (bool): execute request asynchronously Returns: - AacLogicalModel + DeclarativeModel If the method is called asynchronously, returns the request thread. """ @@ -9304,24 +10245,26 @@ def generate_logical_model_aac( data_source_id kwargs['generate_ldm_request'] = \ generate_ldm_request - return self.generate_logical_model_aac_endpoint.call_with_http_info(**kwargs) + return self.generate_logical_model_endpoint.call_with_http_info(**kwargs) - def get_data_source_schemata( + def generate_logical_model_aac( self, data_source_id, + generate_ldm_request, **kwargs ): - """Get a list of schema names of a database # noqa: E501 + """Generate logical data model in AAC format from physical data model (PDM) # noqa: E501 - It scans a database and reads metadata. The result of the request contains a list of schema names of a database. # noqa: E501 + Generate logical data model (LDM) from physical data model (PDM) stored in data source, returning the result in Analytics as Code (AAC) format compatible with the GoodData VSCode extension YAML 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_data_source_schemata(data_source_id, async_req=True) + >>> thread = api.generate_logical_model_aac(data_source_id, generate_ldm_request, async_req=True) >>> result = thread.get() Args: - data_source_id (str): Data source id + data_source_id (str): + generate_ldm_request (GenerateLdmRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -9356,7 +10299,7 @@ def get_data_source_schemata( async_req (bool): execute request asynchronously Returns: - DataSourceSchemata + AacLogicalModel If the method is called asynchronously, returns the request thread. """ @@ -9387,24 +10330,28 @@ def get_data_source_schemata( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['data_source_id'] = \ data_source_id - return self.get_data_source_schemata_endpoint.call_with_http_info(**kwargs) + kwargs['generate_ldm_request'] = \ + generate_ldm_request + return self.generate_logical_model_aac_endpoint.call_with_http_info(**kwargs) - def get_dependent_entities_graph( + def generate_title( self, workspace_id, + generate_title_request, **kwargs ): - """Computes the dependent entities graph # noqa: E501 + """Generate Title for Analytics Object # noqa: E501 - Computes the dependent entities graph # noqa: E501 + Generates a title for the specified analytics object. Returns title and a note with details if generation was not performed. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_dependent_entities_graph(workspace_id, async_req=True) + >>> thread = api.generate_title(workspace_id, generate_title_request, async_req=True) >>> result = thread.get() Args: - workspace_id (str): + workspace_id (str): Workspace identifier + generate_title_request (GenerateTitleRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -9439,7 +10386,7 @@ def get_dependent_entities_graph( async_req (bool): execute request asynchronously Returns: - DependentEntitiesResponse + GenerateTitleResponse If the method is called asynchronously, returns the request thread. """ @@ -9470,26 +10417,26 @@ def get_dependent_entities_graph( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_dependent_entities_graph_endpoint.call_with_http_info(**kwargs) + kwargs['generate_title_request'] = \ + generate_title_request + return self.generate_title_endpoint.call_with_http_info(**kwargs) - def get_dependent_entities_graph_from_entry_points( + def get_data_source_schemata( self, - workspace_id, - dependent_entities_request, + data_source_id, **kwargs ): - """Computes the dependent entities graph from given entry points # noqa: E501 + """Get a list of schema names of a database # noqa: E501 - Computes the dependent entities graph from given entry points # noqa: E501 + It scans a database and reads metadata. The result of the request contains a list of schema names of a database. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_dependent_entities_graph_from_entry_points(workspace_id, dependent_entities_request, async_req=True) + >>> thread = api.get_data_source_schemata(data_source_id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - dependent_entities_request (DependentEntitiesRequest): + data_source_id (str): Data source id Keyword Args: _return_http_data_only (bool): response data without head status @@ -9524,7 +10471,7 @@ def get_dependent_entities_graph_from_entry_points( async_req (bool): execute request asynchronously Returns: - DependentEntitiesResponse + DataSourceSchemata If the method is called asynchronously, returns the request thread. """ @@ -9553,30 +10500,26 @@ def get_dependent_entities_graph_from_entry_points( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['dependent_entities_request'] = \ - dependent_entities_request - return self.get_dependent_entities_graph_from_entry_points_endpoint.call_with_http_info(**kwargs) + kwargs['data_source_id'] = \ + data_source_id + return self.get_data_source_schemata_endpoint.call_with_http_info(**kwargs) - def get_exported_file( + def get_dependent_entities_graph( self, workspace_id, - export_id, **kwargs ): - """Retrieve exported files # noqa: E501 + """Computes the dependent entities graph # noqa: E501 - Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done. # noqa: E501 + Computes the dependent entities graph # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_exported_file(workspace_id, export_id, async_req=True) + >>> thread = api.get_dependent_entities_graph(workspace_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 @@ -9611,7 +10554,265 @@ def get_exported_file( async_req (bool): execute request asynchronously Returns: - file_type + DependentEntitiesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', 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_dependent_entities_graph_endpoint.call_with_http_info(**kwargs) + + def get_dependent_entities_graph_from_entry_points( + self, + workspace_id, + dependent_entities_request, + **kwargs + ): + """Computes the dependent entities graph from given entry points # noqa: E501 + + Computes the dependent entities graph from given entry points # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_dependent_entities_graph_from_entry_points(workspace_id, dependent_entities_request, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + dependent_entities_request (DependentEntitiesRequest): + + 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: + DependentEntitiesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', 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['dependent_entities_request'] = \ + dependent_entities_request + return self.get_dependent_entities_graph_from_entry_points_endpoint.call_with_http_info(**kwargs) + + def get_document( + self, + workspace_id, + filename, + **kwargs + ): + """get_document # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_document(workspace_id, filename, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): Workspace identifier + filename (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: + KnowledgeDocumentMetadataDto + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', 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['filename'] = \ + filename + return self.get_document_endpoint.call_with_http_info(**kwargs) + + def get_exported_file( + self, + workspace_id, + export_id, + **kwargs + ): + """Retrieve exported files # noqa: E501 + + Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_exported_file(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. """ @@ -10934,24 +12135,110 @@ def key_driver_analysis_result( result_id return self.key_driver_analysis_result_endpoint.call_with_http_info(**kwargs) - def list_workspace_user_groups( + def list_documents( self, workspace_id, **kwargs ): - """list_workspace_user_groups # noqa: E501 + """list_documents # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_workspace_user_groups(workspace_id, async_req=True) + >>> thread = api.list_documents(workspace_id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): + workspace_id (str): Workspace identifier Keyword Args: - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + scopes ([str]): [optional] + size (int): [optional] if omitted the server will use the default value of 50 + page_token (str): [optional] + 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: + ListKnowledgeDocumentsResponseDto + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', 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_documents_endpoint.call_with_http_info(**kwargs) + + def list_workspace_user_groups( + self, + workspace_id, + **kwargs + ): + """list_workspace_user_groups # 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_workspace_user_groups(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 name (str): Filter by user name. Note that user name is case insensitive.. [optional] _return_http_data_only (bool): response data without head status @@ -12278,6 +13565,96 @@ def particular_platform_usage( platform_usage_request return self.particular_platform_usage_endpoint.call_with_http_info(**kwargs) + def patch_document( + self, + workspace_id, + filename, + patch_knowledge_document_request_dto, + **kwargs + ): + """patch_document # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_document(workspace_id, filename, patch_knowledge_document_request_dto, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): Workspace identifier + filename (str): + patch_knowledge_document_request_dto (PatchKnowledgeDocumentRequestDto): + + 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: + KnowledgeDocumentMetadataDto + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', 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['filename'] = \ + filename + kwargs['patch_knowledge_document_request_dto'] = \ + patch_knowledge_document_request_dto + return self.patch_document_endpoint.call_with_http_info(**kwargs) + def pause_organization_automations( self, organization_automation_management_bulk_request, @@ -13035,18 +14412,368 @@ def retrieve_result( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.retrieve_result(workspace_id, result_id, async_req=True) + >>> thread = api.retrieve_result(workspace_id, result_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): Workspace identifier + result_id (str): Result ID + + Keyword Args: + offset ([int]): Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.. [optional] if omitted the server will use the default value of [] + limit ([int]): Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.. [optional] if omitted the server will use the default value of [] + excluded_total_dimensions ([str]): 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.. [optional] if omitted the server will use the default value of [] + x_gdc_cancel_token (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: + ExecutionResult + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', 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['result_id'] = \ + result_id + return self.retrieve_result_endpoint.call_with_http_info(**kwargs) + + def retrieve_translations( + self, + workspace_id, + locale_request, + **kwargs + ): + """Retrieve translations for entities. # noqa: E501 + + 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. # 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_translations(workspace_id, locale_request, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + locale_request (LocaleRequest): + + 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: + Xliff + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', 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['locale_request'] = \ + locale_request + return self.retrieve_translations_endpoint.call_with_http_info(**kwargs) + + def scan_data_source( + self, + data_source_id, + scan_request, + **kwargs + ): + """Scan a database to get a physical data model (PDM) # noqa: E501 + + 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. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.scan_data_source(data_source_id, scan_request, async_req=True) + >>> result = thread.get() + + Args: + data_source_id (str): Data source id + scan_request (ScanRequest): + + 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: + ScanResultPdm + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', 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['scan_request'] = \ + scan_request + return self.scan_data_source_endpoint.call_with_http_info(**kwargs) + + def scan_sql( + self, + data_source_id, + scan_sql_request, + **kwargs + ): + """Collect metadata about SQL query # noqa: E501 + + 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 # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.scan_sql(data_source_id, scan_sql_request, async_req=True) + >>> result = thread.get() + + Args: + data_source_id (str): Data source id + scan_sql_request (ScanSqlRequest): + + 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: + ScanSqlResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', 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['scan_sql_request'] = \ + scan_sql_request + return self.scan_sql_endpoint.call_with_http_info(**kwargs) + + def search_knowledge( + self, + workspace_id, + query, + **kwargs + ): + """search_knowledge # 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_knowledge(workspace_id, query, async_req=True) >>> result = thread.get() Args: workspace_id (str): Workspace identifier - result_id (str): Result ID + query (str): Keyword Args: - offset ([int]): Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.. [optional] if omitted the server will use the default value of [] - limit ([int]): Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.. [optional] if omitted the server will use the default value of [] - excluded_total_dimensions ([str]): 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.. [optional] if omitted the server will use the default value of [] - x_gdc_cancel_token (str): [optional] + limit (int): [optional] if omitted the server will use the default value of 10 + min_score (float): [optional] if omitted the server will use the default value of 0.0 + scopes ([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 @@ -13079,7 +14806,7 @@ def retrieve_result( async_req (bool): execute request asynchronously Returns: - ExecutionResult + SearchKnowledgeResponseDto If the method is called asynchronously, returns the request thread. """ @@ -13110,28 +14837,28 @@ def retrieve_result( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['result_id'] = \ - result_id - return self.retrieve_result_endpoint.call_with_http_info(**kwargs) + kwargs['query'] = \ + query + return self.search_knowledge_endpoint.call_with_http_info(**kwargs) - def retrieve_translations( + def set_certification( self, workspace_id, - locale_request, + set_certification_request, **kwargs ): - """Retrieve translations for entities. # noqa: E501 + """Set Certification # noqa: E501 - 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. # noqa: E501 + Set or clear the certification (e.g. CERTIFIED) of a workspace entity. Requires MANAGE permission. # 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_translations(workspace_id, locale_request, async_req=True) + >>> thread = api.set_certification(workspace_id, set_certification_request, async_req=True) >>> result = thread.get() Args: workspace_id (str): - locale_request (LocaleRequest): + set_certification_request (SetCertificationRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -13166,7 +14893,7 @@ def retrieve_translations( async_req (bool): execute request asynchronously Returns: - Xliff + None If the method is called asynchronously, returns the request thread. """ @@ -13197,28 +14924,28 @@ def retrieve_translations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['locale_request'] = \ - locale_request - return self.retrieve_translations_endpoint.call_with_http_info(**kwargs) + kwargs['set_certification_request'] = \ + set_certification_request + return self.set_certification_endpoint.call_with_http_info(**kwargs) - def scan_data_source( + def set_translations( self, - data_source_id, - scan_request, + workspace_id, + xliff, **kwargs ): - """Scan a database to get a physical data model (PDM) # noqa: E501 + """Set translations for entities. # noqa: E501 - 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. # noqa: E501 + Set translation for existing entities in a particular locale. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.scan_data_source(data_source_id, scan_request, async_req=True) + >>> thread = api.set_translations(workspace_id, xliff, async_req=True) >>> result = thread.get() Args: - data_source_id (str): Data source id - scan_request (ScanRequest): + workspace_id (str): + xliff (Xliff): Keyword Args: _return_http_data_only (bool): response data without head status @@ -13253,7 +14980,7 @@ def scan_data_source( async_req (bool): execute request asynchronously Returns: - ScanResultPdm + None If the method is called asynchronously, returns the request thread. """ @@ -13282,30 +15009,28 @@ def scan_data_source( '_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['scan_request'] = \ - scan_request - return self.scan_data_source_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['xliff'] = \ + xliff + return self.set_translations_endpoint.call_with_http_info(**kwargs) - def scan_sql( + def switch_active_identity_provider( self, - data_source_id, - scan_sql_request, + switch_identity_provider_request, **kwargs ): - """Collect metadata about SQL query # noqa: E501 + """Switch Active Identity Provider # noqa: E501 - 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 # noqa: E501 + Switch the active identity provider for the organization. Requires MANAGE permission on the organization. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.scan_sql(data_source_id, scan_sql_request, async_req=True) + >>> thread = api.switch_active_identity_provider(switch_identity_provider_request, async_req=True) >>> result = thread.get() Args: - data_source_id (str): Data source id - scan_sql_request (ScanSqlRequest): + switch_identity_provider_request (SwitchIdentityProviderRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -13340,7 +15065,7 @@ def scan_sql( async_req (bool): execute request asynchronously Returns: - ScanSqlResponse + None If the method is called asynchronously, returns the request thread. """ @@ -13369,30 +15094,26 @@ def scan_sql( '_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['scan_sql_request'] = \ - scan_sql_request - return self.scan_sql_endpoint.call_with_http_info(**kwargs) + kwargs['switch_identity_provider_request'] = \ + switch_identity_provider_request + return self.switch_active_identity_provider_endpoint.call_with_http_info(**kwargs) - def set_translations( + def tags( self, workspace_id, - xliff, **kwargs ): - """Set translations for entities. # noqa: E501 + """Get Analytics Catalog Tags # noqa: E501 - Set translation for existing entities in a particular locale. # noqa: E501 + Returns a list of tags 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.set_translations(workspace_id, xliff, async_req=True) + >>> thread = api.tags(workspace_id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - xliff (Xliff): + workspace_id (str): Workspace identifier Keyword Args: _return_http_data_only (bool): response data without head status @@ -13427,7 +15148,7 @@ def set_translations( async_req (bool): execute request asynchronously Returns: - None + AnalyticsCatalogTags If the method is called asynchronously, returns the request thread. """ @@ -13458,26 +15179,26 @@ def set_translations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['xliff'] = \ - xliff - return self.set_translations_endpoint.call_with_http_info(**kwargs) + return self.tags_endpoint.call_with_http_info(**kwargs) - def switch_active_identity_provider( + def test_data_source( self, - switch_identity_provider_request, + data_source_id, + test_request, **kwargs ): - """Switch Active Identity Provider # noqa: E501 + """Test data source connection by data source id # noqa: E501 - Switch the active identity provider for the organization. Requires MANAGE permission on the organization. # noqa: E501 + Test if it is possible to connect to a database using an existing data source 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.switch_active_identity_provider(switch_identity_provider_request, async_req=True) + >>> thread = api.test_data_source(data_source_id, test_request, async_req=True) >>> result = thread.get() Args: - switch_identity_provider_request (SwitchIdentityProviderRequest): + data_source_id (str): Data source id + test_request (TestRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -13512,7 +15233,7 @@ def switch_active_identity_provider( async_req (bool): execute request asynchronously Returns: - None + TestResponse If the method is called asynchronously, returns the request thread. """ @@ -13541,26 +15262,28 @@ def switch_active_identity_provider( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['switch_identity_provider_request'] = \ - switch_identity_provider_request - return self.switch_active_identity_provider_endpoint.call_with_http_info(**kwargs) + kwargs['data_source_id'] = \ + data_source_id + kwargs['test_request'] = \ + test_request + return self.test_data_source_endpoint.call_with_http_info(**kwargs) - def tags( + def test_data_source_definition( self, - workspace_id, + test_definition_request, **kwargs ): - """Get Analytics Catalog Tags # noqa: E501 + """Test connection by data source definition # noqa: E501 - Returns a list of tags for this workspace # noqa: E501 + Test if it is possible to connect to a database using a connection provided by the data source definition in the request body. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.tags(workspace_id, async_req=True) + >>> thread = api.test_data_source_definition(test_definition_request, async_req=True) >>> result = thread.get() Args: - workspace_id (str): Workspace identifier + test_definition_request (TestDefinitionRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -13595,7 +15318,7 @@ def tags( async_req (bool): execute request asynchronously Returns: - AnalyticsCatalogTags + TestResponse If the method is called asynchronously, returns the request thread. """ @@ -13624,30 +15347,29 @@ def tags( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.tags_endpoint.call_with_http_info(**kwargs) + kwargs['test_definition_request'] = \ + test_definition_request + return self.test_data_source_definition_endpoint.call_with_http_info(**kwargs) - def test_data_source( + def test_existing_notification_channel( self, - data_source_id, - test_request, + notification_channel_id, **kwargs ): - """Test data source connection by data source id # noqa: E501 + """Test existing notification channel. # noqa: E501 - Test if it is possible to connect to a database using an existing data source definition. # noqa: E501 + Tests the existing notification channel by sending a test notification. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.test_data_source(data_source_id, test_request, async_req=True) + >>> thread = api.test_existing_notification_channel(notification_channel_id, async_req=True) >>> result = thread.get() Args: - data_source_id (str): Data source id - test_request (TestRequest): + notification_channel_id (str): Keyword Args: + test_destination_request (TestDestinationRequest): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -13709,28 +15431,26 @@ def test_data_source( '_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['test_request'] = \ - test_request - return self.test_data_source_endpoint.call_with_http_info(**kwargs) + kwargs['notification_channel_id'] = \ + notification_channel_id + return self.test_existing_notification_channel_endpoint.call_with_http_info(**kwargs) - def test_data_source_definition( + def test_llm_provider( self, - test_definition_request, + test_llm_provider_definition_request, **kwargs ): - """Test connection by data source definition # noqa: E501 + """Test LLM Provider # noqa: E501 - Test if it is possible to connect to a database using a connection provided by the data source definition in the request body. # noqa: E501 + Tests LLM provider connectivity with a full 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.test_data_source_definition(test_definition_request, async_req=True) + >>> thread = api.test_llm_provider(test_llm_provider_definition_request, async_req=True) >>> result = thread.get() Args: - test_definition_request (TestDefinitionRequest): + test_llm_provider_definition_request (TestLlmProviderDefinitionRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -13765,7 +15485,7 @@ def test_data_source_definition( async_req (bool): execute request asynchronously Returns: - TestResponse + TestLlmProviderResponse If the method is called asynchronously, returns the request thread. """ @@ -13794,29 +15514,28 @@ def test_data_source_definition( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['test_definition_request'] = \ - test_definition_request - return self.test_data_source_definition_endpoint.call_with_http_info(**kwargs) + kwargs['test_llm_provider_definition_request'] = \ + test_llm_provider_definition_request + return self.test_llm_provider_endpoint.call_with_http_info(**kwargs) - def test_existing_notification_channel( + def test_llm_provider_by_id( self, - notification_channel_id, + llm_provider_id, **kwargs ): - """Test existing notification channel. # noqa: E501 + """Test LLM Provider By Id # noqa: E501 - Tests the existing notification channel by sending a test notification. # noqa: E501 + Tests an existing LLM provider connectivity by its ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.test_existing_notification_channel(notification_channel_id, async_req=True) + >>> thread = api.test_llm_provider_by_id(llm_provider_id, async_req=True) >>> result = thread.get() Args: - notification_channel_id (str): + llm_provider_id (str): Keyword Args: - test_destination_request (TestDestinationRequest): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -13849,7 +15568,7 @@ def test_existing_notification_channel( async_req (bool): execute request asynchronously Returns: - TestResponse + TestLlmProviderResponse If the method is called asynchronously, returns the request thread. """ @@ -13878,9 +15597,9 @@ def test_existing_notification_channel( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['notification_channel_id'] = \ - notification_channel_id - return self.test_existing_notification_channel_endpoint.call_with_http_info(**kwargs) + kwargs['llm_provider_id'] = \ + llm_provider_id + return self.test_llm_provider_by_id_endpoint.call_with_http_info(**kwargs) def test_notification_channel( self, @@ -14803,6 +16522,92 @@ def unsubscribe_workspace_automations( workspace_id return self.unsubscribe_workspace_automations_endpoint.call_with_http_info(**kwargs) + def upsert_document( + self, + workspace_id, + upsert_knowledge_document_request_dto, + **kwargs + ): + """upsert_document # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.upsert_document(workspace_id, upsert_knowledge_document_request_dto, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): Workspace identifier + upsert_knowledge_document_request_dto (UpsertKnowledgeDocumentRequestDto): + + 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: + UpsertKnowledgeDocumentResponseDto + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', 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['upsert_knowledge_document_request_dto'] = \ + upsert_knowledge_document_request_dto + return self.upsert_document_endpoint.call_with_http_info(**kwargs) + def validate_llm_endpoint( self, validate_llm_endpoint_request, 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 777746df8..f669f1b12 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,6 +25,8 @@ from gooddata_api_client.model.database_instance import DatabaseInstance from gooddata_api_client.model.get_ai_lake_operation200_response import GetAiLakeOperation200Response from gooddata_api_client.model.provision_database_instance_request import ProvisionDatabaseInstanceRequest +from gooddata_api_client.model.run_service_command_request import RunServiceCommandRequest +from gooddata_api_client.model.service_info import ServiceInfo class AILakeApi(object): @@ -42,7 +44,7 @@ def __init__(self, api_client=None): settings={ 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), 'auth': [], - 'endpoint_path': '/api/v1/ailake/database/instance/{instanceId}', + 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}', 'operation_id': 'deprovision_ai_lake_database_instance', 'http_method': 'DELETE', 'servers': None, @@ -96,7 +98,7 @@ def __init__(self, api_client=None): settings={ 'response_type': (DatabaseInstance,), 'auth': [], - 'endpoint_path': '/api/v1/ailake/database/instance/{instanceId}', + 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}', 'operation_id': 'get_ai_lake_database_instance', 'http_method': 'GET', 'servers': None, @@ -145,7 +147,7 @@ def __init__(self, api_client=None): settings={ 'response_type': (GetAiLakeOperation200Response,), 'auth': [], - 'endpoint_path': '/api/v1/ailake/operation/{operationId}', + 'endpoint_path': '/api/v1/ailake/operations/{operationId}', 'operation_id': 'get_ai_lake_operation', 'http_method': 'GET', 'servers': None, @@ -190,11 +192,95 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.list_ai_lake_database_instances_endpoint = _Endpoint( + settings={ + 'response_type': ([DatabaseInstance],), + 'auth': [], + 'endpoint_path': '/api/v1/ailake/database/instances', + 'operation_id': 'list_ai_lake_database_instances', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.list_ai_lake_services_endpoint = _Endpoint( + settings={ + 'response_type': ([ServiceInfo],), + 'auth': [], + 'endpoint_path': '/api/v1/ailake/services', + 'operation_id': 'list_ai_lake_services', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.provision_ai_lake_database_instance_endpoint = _Endpoint( settings={ 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), 'auth': [], - 'endpoint_path': '/api/v1/ailake/database/instance', + 'endpoint_path': '/api/v1/ailake/database/instances', 'operation_id': 'provision_ai_lake_database_instance', 'http_method': 'POST', 'servers': None, @@ -245,6 +331,73 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.run_ai_lake_service_command_endpoint = _Endpoint( + settings={ + 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'auth': [], + 'endpoint_path': '/api/v1/ailake/services/{serviceId}/commands/{commandName}/run', + 'operation_id': 'run_ai_lake_service_command', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'command_name', + 'run_service_command_request', + 'operation_id', + ], + 'required': [ + 'service_id', + 'command_name', + 'run_service_command_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'command_name': + (str,), + 'run_service_command_request': + (RunServiceCommandRequest,), + 'operation_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'serviceId', + 'command_name': 'commandName', + 'operation_id': 'operation-id', + }, + 'location_map': { + 'service_id': 'path', + 'command_name': 'path', + 'run_service_command_request': 'body', + 'operation_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) def deprovision_ai_lake_database_instance( self, @@ -496,6 +649,162 @@ def get_ai_lake_operation( operation_id return self.get_ai_lake_operation_endpoint.call_with_http_info(**kwargs) + def list_ai_lake_database_instances( + self, + **kwargs + ): + """(BETA) List AI Lake Database instances # noqa: E501 + + (BETA) Lists database instances in the organization's AI Lake. # 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_database_instances(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: + [DatabaseInstance] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_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.list_ai_lake_database_instances_endpoint.call_with_http_info(**kwargs) + + def list_ai_lake_services( + self, + **kwargs + ): + """(BETA) List AI Lake services # noqa: E501 + + (BETA) Lists services configured for the organization's AI Lake. Returns only non-sensitive fields (id, name). # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_ai_lake_services(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: + [ServiceInfo] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_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.list_ai_lake_services_endpoint.call_with_http_info(**kwargs) + def provision_ai_lake_database_instance( self, provision_database_instance_request, @@ -580,3 +889,95 @@ def provision_ai_lake_database_instance( provision_database_instance_request return self.provision_ai_lake_database_instance_endpoint.call_with_http_info(**kwargs) + def run_ai_lake_service_command( + self, + service_id, + command_name, + run_service_command_request, + **kwargs + ): + """(BETA) Run an AI Lake services command # noqa: E501 + + (BETA) Runs a specific AI Lake service command. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.run_ai_lake_service_command(service_id, command_name, run_service_command_request, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): + command_name (str): + run_service_command_request (RunServiceCommandRequest): + + 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: + {str: (bool, date, datetime, dict, float, int, list, str, none_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['service_id'] = \ + service_id + kwargs['command_name'] = \ + command_name + kwargs['run_service_command_request'] = \ + run_service_command_request + return self.run_ai_lake_service_command_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/certification_api.py b/gooddata-api-client/gooddata_api_client/api/certification_api.py new file mode 100644 index 000000000..e150d3d01 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/certification_api.py @@ -0,0 +1,180 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI 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.set_certification_request import SetCertificationRequest + + +class CertificationApi(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.set_certification_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/setCertification', + 'operation_id': 'set_certification', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'set_certification_request', + ], + 'required': [ + 'workspace_id', + 'set_certification_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'set_certification_request': + (SetCertificationRequest,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'set_certification_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def set_certification( + self, + workspace_id, + set_certification_request, + **kwargs + ): + """Set Certification # noqa: E501 + + Set or clear the certification (e.g. CERTIFIED) of a workspace entity. Requires MANAGE permission. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.set_certification(workspace_id, set_certification_request, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + set_certification_request (SetCertificationRequest): + + 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['set_certification_request'] = \ + set_certification_request + return self.set_certification_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 6402f33ea..5bd88d55d 100644 --- a/gooddata-api-client/gooddata_api_client/api/dashboards_api.py +++ b/gooddata-api-client/gooddata_api_client/api/dashboards_api.py @@ -90,6 +90,7 @@ def __init__(self, api_client=None): "DASHBOARDPLUGINS": "dashboardPlugins", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -257,6 +258,7 @@ def __init__(self, api_client=None): "DASHBOARDPLUGINS": "dashboardPlugins", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -377,6 +379,7 @@ def __init__(self, api_client=None): "DASHBOARDPLUGINS": "dashboardPlugins", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -478,6 +481,7 @@ def __init__(self, api_client=None): "DASHBOARDPLUGINS": "dashboardPlugins", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, @@ -642,6 +646,7 @@ def __init__(self, api_client=None): "DASHBOARDPLUGINS": "dashboardPlugins", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, 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 352992ed7..0b67eeb16 100644 --- a/gooddata-api-client/gooddata_api_client/api/entities_api.py +++ b/gooddata-api-client/gooddata_api_client/api/entities_api.py @@ -123,6 +123,10 @@ from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument from gooddata_api_client.model.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList from gooddata_api_client.model.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from gooddata_api_client.model.json_api_llm_provider_in_document import JsonApiLlmProviderInDocument +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument +from gooddata_api_client.model.json_api_llm_provider_out_list import JsonApiLlmProviderOutList +from gooddata_api_client.model.json_api_llm_provider_patch_document import JsonApiLlmProviderPatchDocument 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 @@ -254,6 +258,7 @@ def __init__(self, api_client=None): "DASHBOARDPLUGINS": "dashboardPlugins", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -1492,6 +1497,58 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.create_entity_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLlmProviderOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders', + 'operation_id': 'create_entity_llm_providers', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'json_api_llm_provider_in_document', + ], + 'required': [ + 'json_api_llm_provider_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'json_api_llm_provider_in_document': + (JsonApiLlmProviderInDocument,), + }, + 'attribute_map': { + }, + 'location_map': { + 'json_api_llm_provider_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_memory_items_endpoint = _Endpoint( settings={ 'response_type': (JsonApiMemoryItemOutDocument,), @@ -1628,6 +1685,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -2160,6 +2218,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -3602,6 +3661,65 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.delete_entity_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders/{id}', + 'operation_id': 'delete_entity_llm_providers', + 'http_method': 'DELETE', + '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': [], + 'content_type': [], + }, + api_client=api_client + ) self.delete_entity_memory_items_endpoint = _Endpoint( settings={ 'response_type': None, @@ -4713,6 +4831,7 @@ def __init__(self, api_client=None): "DASHBOARDPLUGINS": "dashboardPlugins", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -7127,6 +7246,87 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_all_entities_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLlmProviderOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders', + 'operation_id': 'get_all_entities_llm_providers', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filter', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_all_entities_memory_items_endpoint = _Endpoint( settings={ 'response_type': (JsonApiMemoryItemOutList,), @@ -7305,6 +7505,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -8236,6 +8437,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -8978,6 +9180,7 @@ def __init__(self, api_client=None): "DASHBOARDPLUGINS": "dashboardPlugins", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -10970,6 +11173,68 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_entity_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLlmProviderOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders/{id}', + 'operation_id': 'get_entity_llm_providers', + '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_memory_items_endpoint = _Endpoint( settings={ 'response_type': (JsonApiMemoryItemOutDocument,), @@ -11116,6 +11381,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -11944,6 +12210,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -12469,6 +12736,7 @@ def __init__(self, api_client=None): "DASHBOARDPLUGINS": "dashboardPlugins", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, @@ -14145,6 +14413,76 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.patch_entity_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLlmProviderOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders/{id}', + 'operation_id': 'patch_entity_llm_providers', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_llm_provider_patch_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_llm_provider_patch_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_llm_provider_patch_document': + (JsonApiLlmProviderPatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_llm_provider_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.patch_entity_memory_items_endpoint = _Endpoint( settings={ 'response_type': (JsonApiMemoryItemOutDocument,), @@ -14272,6 +14610,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, @@ -14911,6 +15250,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, @@ -16945,6 +17285,7 @@ def __init__(self, api_client=None): "DASHBOARDPLUGINS": "dashboardPlugins", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, @@ -18286,6 +18627,76 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.update_entity_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLlmProviderOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders/{id}', + 'operation_id': 'update_entity_llm_providers', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_llm_provider_in_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_llm_provider_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_llm_provider_in_document': + (JsonApiLlmProviderInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_llm_provider_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_memory_items_endpoint = _Endpoint( settings={ 'response_type': (JsonApiMemoryItemOutDocument,), @@ -18413,6 +18824,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, @@ -19128,6 +19540,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, @@ -20655,7 +21068,91 @@ def create_entity_filter_views( async_req (bool): execute request asynchronously Returns: - JsonApiFilterViewOutDocument + 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. """ @@ -20684,27 +21181,26 @@ def create_entity_filter_views( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_filter_view_in_document'] = \ - json_api_filter_view_in_document - return self.create_entity_filter_views_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_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_identity_providers( + def create_entity_jwks( self, - json_api_identity_provider_in_document, + json_api_jwk_in_document, **kwargs ): - """Post Identity Providers # noqa: E501 + """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_identity_providers(json_api_identity_provider_in_document, async_req=True) + >>> thread = api.create_entity_jwks(json_api_jwk_in_document, async_req=True) >>> result = thread.get() Args: - json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): + json_api_jwk_in_document (JsonApiJwkInDocument): Keyword Args: _return_http_data_only (bool): response data without head status @@ -20739,7 +21235,7 @@ def create_entity_identity_providers( async_req (bool): execute request asynchronously Returns: - JsonApiIdentityProviderOutDocument + JsonApiJwkOutDocument If the method is called asynchronously, returns the request thread. """ @@ -20768,28 +21264,31 @@ 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['json_api_jwk_in_document'] = \ + json_api_jwk_in_document + return self.create_entity_jwks_endpoint.call_with_http_info(**kwargs) - def create_entity_jwks( + def create_entity_knowledge_recommendations( self, - json_api_jwk_in_document, + workspace_id, + json_api_knowledge_recommendation_post_optional_id_document, **kwargs ): - """Post Jwks # noqa: E501 + """create_entity_knowledge_recommendations # 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_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, async_req=True) >>> result = thread.get() Args: - json_api_jwk_in_document (JsonApiJwkInDocument): + 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 @@ -20822,7 +21321,7 @@ def create_entity_jwks( async_req (bool): execute request asynchronously Returns: - JsonApiJwkOutDocument + JsonApiKnowledgeRecommendationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -20851,31 +21350,29 @@ 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_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_knowledge_recommendations( + def create_entity_llm_endpoints( self, - workspace_id, - json_api_knowledge_recommendation_post_optional_id_document, + json_api_llm_endpoint_in_document, **kwargs ): - """create_entity_knowledge_recommendations # noqa: E501 + """Post LLM endpoint 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_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_llm_endpoints(json_api_llm_endpoint_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - json_api_knowledge_recommendation_post_optional_id_document (JsonApiKnowledgeRecommendationPostOptionalIdDocument): + json_api_llm_endpoint_in_document (JsonApiLlmEndpointInDocument): 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 @@ -20908,7 +21405,7 @@ def create_entity_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutDocument + JsonApiLlmEndpointOutDocument If the method is called asynchronously, returns the request thread. """ @@ -20937,27 +21434,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_llm_endpoint_in_document'] = \ + json_api_llm_endpoint_in_document + return self.create_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) - def create_entity_llm_endpoints( + def create_entity_llm_providers( self, - json_api_llm_endpoint_in_document, + json_api_llm_provider_in_document, **kwargs ): - """Post LLM endpoint entities # noqa: E501 + """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_endpoints(json_api_llm_endpoint_in_document, 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_endpoint_in_document (JsonApiLlmEndpointInDocument): + json_api_llm_provider_in_document (JsonApiLlmProviderInDocument): Keyword Args: _return_http_data_only (bool): response data without head status @@ -20992,7 +21488,7 @@ def create_entity_llm_endpoints( async_req (bool): execute request asynchronously Returns: - JsonApiLlmEndpointOutDocument + JsonApiLlmProviderOutDocument If the method is called asynchronously, returns the request thread. """ @@ -21021,9 +21517,9 @@ def create_entity_llm_endpoints( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_llm_endpoint_in_document'] = \ - json_api_llm_endpoint_in_document - return self.create_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + 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, @@ -23166,103 +23662,190 @@ def delete_entity_export_definitions( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - - def delete_entity_export_templates( - self, - id, - **kwargs - ): - """Delete Export Template entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_export_templates(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_export_templates_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + + def delete_entity_export_templates( + self, + id, + **kwargs + ): + """Delete Export Template entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_export_templates(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_entity_export_templates_endpoint.call_with_http_info(**kwargs) + + def delete_entity_filter_contexts( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Filter Context # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_filter_contexts(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] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a 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_filter_contexts_endpoint.call_with_http_info(**kwargs) - def delete_entity_filter_contexts( + def delete_entity_filter_views( self, workspace_id, object_id, **kwargs ): - """Delete a Filter Context # noqa: E501 + """Delete Filter view # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_filter_contexts(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_filter_views(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -23336,25 +23919,23 @@ def delete_entity_filter_contexts( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_filter_views_endpoint.call_with_http_info(**kwargs) - def delete_entity_filter_views( + def delete_entity_identity_providers( self, - workspace_id, - object_id, + id, **kwargs ): - """Delete Filter view # noqa: E501 + """Delete Identity Provider # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_filter_views(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_identity_providers(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -23419,23 +24000,22 @@ def delete_entity_filter_views( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_filter_views_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - def delete_entity_identity_providers( + def delete_entity_jwks( self, id, **kwargs ): - """Delete Identity Provider # noqa: E501 + """Delete Jwk # noqa: E501 + Deletes JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_identity_providers(id, async_req=True) + >>> thread = api.delete_entity_jwks(id, async_req=True) >>> result = thread.get() Args: @@ -23506,24 +24086,25 @@ def delete_entity_identity_providers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_jwks_endpoint.call_with_http_info(**kwargs) - def delete_entity_jwks( + def delete_entity_knowledge_recommendations( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete Jwk # noqa: E501 + """delete_entity_knowledge_recommendations # noqa: E501 - Deletes JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_jwks(id, async_req=True) + >>> thread = api.delete_entity_knowledge_recommendations(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -23588,27 +24169,27 @@ def delete_entity_jwks( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_jwks_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def delete_entity_knowledge_recommendations( + def delete_entity_llm_endpoints( self, - workspace_id, - object_id, + id, **kwargs ): - """delete_entity_knowledge_recommendations # noqa: E501 + """delete_entity_llm_endpoints # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_knowledge_recommendations(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_llm_endpoints(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] @@ -23673,23 +24254,21 @@ def delete_entity_knowledge_recommendations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) - def delete_entity_llm_endpoints( + def delete_entity_llm_providers( self, id, **kwargs ): - """delete_entity_llm_endpoints # noqa: E501 + """Delete LLM Provider entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_llm_endpoints(id, async_req=True) + >>> thread = api.delete_entity_llm_providers(id, async_req=True) >>> result = thread.get() Args: @@ -23760,7 +24339,7 @@ def delete_entity_llm_endpoints( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_llm_providers_endpoint.call_with_http_info(**kwargs) def delete_entity_memory_items( self, @@ -27038,32 +27617,116 @@ 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_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_labels( + self, + workspace_id, + **kwargs + ): + """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_labels(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: + JsonApiLabelOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', 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_labels_endpoint.call_with_http_info(**kwargs) - def get_all_entities_labels( + def get_all_entities_llm_endpoints( self, - workspace_id, **kwargs ): - """Get all Labels # noqa: E501 + """Get all LLM endpoint entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_labels(workspace_id, async_req=True) + >>> thread = api.get_all_entities_llm_endpoints(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. @@ -27097,7 +27760,7 @@ def get_all_entities_labels( async_req (bool): execute request asynchronously Returns: - JsonApiLabelOutList + JsonApiLlmEndpointOutList If the method is called asynchronously, returns the request thread. """ @@ -27126,20 +27789,18 @@ def get_all_entities_labels( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_labels_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_llm_endpoints_endpoint.call_with_http_info(**kwargs) - def get_all_entities_llm_endpoints( + def get_all_entities_llm_providers( self, **kwargs ): - """Get all LLM endpoint entities # 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_llm_endpoints(async_req=True) + >>> thread = api.get_all_entities_llm_providers(async_req=True) >>> result = thread.get() @@ -27181,7 +27842,7 @@ def get_all_entities_llm_endpoints( async_req (bool): execute request asynchronously Returns: - JsonApiLlmEndpointOutList + JsonApiLlmProviderOutList If the method is called asynchronously, returns the request thread. """ @@ -27210,7 +27871,7 @@ def get_all_entities_llm_endpoints( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_llm_endpoints_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_llm_providers_endpoint.call_with_http_info(**kwargs) def get_all_entities_memory_items( self, @@ -31011,6 +31672,89 @@ def get_entity_llm_endpoints( id return self.get_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + def get_entity_llm_providers( + self, + id, + **kwargs + ): + """Get 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.get_entity_llm_providers(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: + 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['id'] = \ + id + return self.get_entity_llm_providers_endpoint.call_with_http_info(**kwargs) + def get_entity_memory_items( self, workspace_id, @@ -34544,6 +35288,93 @@ def patch_entity_llm_endpoints( json_api_llm_endpoint_patch_document return self.patch_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + def patch_entity_llm_providers( + self, + id, + json_api_llm_provider_patch_document, + **kwargs + ): + """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_llm_providers(id, json_api_llm_provider_patch_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + 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] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a 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['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) + def patch_entity_memory_items( self, workspace_id, @@ -39352,6 +40183,93 @@ def update_entity_llm_endpoints( json_api_llm_endpoint_in_document return self.update_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + def update_entity_llm_providers( + self, + id, + json_api_llm_provider_in_document, + **kwargs + ): + """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_llm_providers(id, json_api_llm_provider_in_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + 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] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a 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['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, diff --git a/gooddata-api-client/gooddata_api_client/api/llm_providers_api.py b/gooddata-api-client/gooddata_api_client/api/llm_providers_api.py new file mode 100644 index 000000000..c2db36e59 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/llm_providers_api.py @@ -0,0 +1,941 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI 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_llm_provider_in_document import JsonApiLlmProviderInDocument +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument +from gooddata_api_client.model.json_api_llm_provider_out_list import JsonApiLlmProviderOutList +from gooddata_api_client.model.json_api_llm_provider_patch_document import JsonApiLlmProviderPatchDocument + + +class LLMProvidersApi(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_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLlmProviderOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders', + 'operation_id': 'create_entity_llm_providers', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'json_api_llm_provider_in_document', + ], + 'required': [ + 'json_api_llm_provider_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'json_api_llm_provider_in_document': + (JsonApiLlmProviderInDocument,), + }, + 'attribute_map': { + }, + 'location_map': { + 'json_api_llm_provider_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.delete_entity_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders/{id}', + 'operation_id': 'delete_entity_llm_providers', + 'http_method': 'DELETE', + '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': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLlmProviderOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders', + 'operation_id': 'get_all_entities_llm_providers', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filter', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLlmProviderOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders/{id}', + 'operation_id': 'get_entity_llm_providers', + '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.patch_entity_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLlmProviderOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders/{id}', + 'operation_id': 'patch_entity_llm_providers', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_llm_provider_patch_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_llm_provider_patch_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_llm_provider_patch_document': + (JsonApiLlmProviderPatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_llm_provider_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLlmProviderOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders/{id}', + 'operation_id': 'update_entity_llm_providers', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_llm_provider_in_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_llm_provider_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_llm_provider_in_document': + (JsonApiLlmProviderInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_llm_provider_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_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 delete_entity_llm_providers( + self, + id, + **kwargs + ): + """Delete LLM Provider entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_llm_providers(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: + 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_llm_providers_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_llm_providers( + self, + **kwargs + ): + """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_llm_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: + JsonApiLlmProviderOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_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_llm_providers_endpoint.call_with_http_info(**kwargs) + + def get_entity_llm_providers( + self, + id, + **kwargs + ): + """Get 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.get_entity_llm_providers(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: + 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['id'] = \ + id + return self.get_entity_llm_providers_endpoint.call_with_http_info(**kwargs) + + def patch_entity_llm_providers( + self, + id, + json_api_llm_provider_patch_document, + **kwargs + ): + """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_llm_providers(id, json_api_llm_provider_patch_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + 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] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a 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['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) + + def update_entity_llm_providers( + self, + id, + json_api_llm_provider_in_document, + **kwargs + ): + """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_llm_providers(id, json_api_llm_provider_in_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + 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] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a 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['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) + 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 e945b664b..914bce346 100644 --- a/gooddata-api-client/gooddata_api_client/api/metrics_api.py +++ b/gooddata-api-client/gooddata_api_client/api/metrics_api.py @@ -88,6 +88,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -251,6 +252,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -367,6 +369,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -464,6 +467,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, @@ -626,6 +630,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, diff --git a/gooddata-api-client/gooddata_api_client/api/organization_model_controller_api.py b/gooddata-api-client/gooddata_api_client/api/organization_model_controller_api.py index 86caf1455..fbfbc7396 100644 --- a/gooddata-api-client/gooddata_api_client/api/organization_model_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/organization_model_controller_api.py @@ -59,6 +59,10 @@ from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument from gooddata_api_client.model.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList from gooddata_api_client.model.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from gooddata_api_client.model.json_api_llm_provider_in_document import JsonApiLlmProviderInDocument +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument +from gooddata_api_client.model.json_api_llm_provider_out_list import JsonApiLlmProviderOutList +from gooddata_api_client.model.json_api_llm_provider_patch_document import JsonApiLlmProviderPatchDocument from gooddata_api_client.model.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument from gooddata_api_client.model.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList from gooddata_api_client.model.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument @@ -534,6 +538,58 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.create_entity_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLlmProviderOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders', + 'operation_id': 'create_entity_llm_providers', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'json_api_llm_provider_in_document', + ], + 'required': [ + 'json_api_llm_provider_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'json_api_llm_provider_in_document': + (JsonApiLlmProviderInDocument,), + }, + 'attribute_map': { + }, + 'location_map': { + 'json_api_llm_provider_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_notification_channels_endpoint = _Endpoint( settings={ 'response_type': (JsonApiNotificationChannelOutDocument,), @@ -1376,6 +1432,65 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.delete_entity_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders/{id}', + 'operation_id': 'delete_entity_llm_providers', + 'http_method': 'DELETE', + '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': [], + 'content_type': [], + }, + api_client=api_client + ) self.delete_entity_notification_channels_endpoint = _Endpoint( settings={ 'response_type': None, @@ -2542,6 +2657,87 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_all_entities_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLlmProviderOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders', + 'operation_id': 'get_all_entities_llm_providers', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filter', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_all_entities_notification_channel_identifiers_endpoint = _Endpoint( settings={ 'response_type': (JsonApiNotificationChannelIdentifierOutList,), @@ -3886,6 +4082,68 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_entity_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLlmProviderOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders/{id}', + 'operation_id': 'get_entity_llm_providers', + '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_notification_channel_identifiers_endpoint = _Endpoint( settings={ 'response_type': (JsonApiNotificationChannelIdentifierOutDocument,), @@ -5000,24 +5258,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_notification_channels_endpoint = _Endpoint( + self.patch_entity_llm_providers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiNotificationChannelOutDocument,), + 'response_type': (JsonApiLlmProviderOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', - 'operation_id': 'patch_entity_notification_channels', + 'endpoint_path': '/api/v1/entities/llmProviders/{id}', + 'operation_id': 'patch_entity_llm_providers', 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_notification_channel_patch_document', + 'json_api_llm_provider_patch_document', 'filter', ], 'required': [ 'id', - 'json_api_notification_channel_patch_document', + 'json_api_llm_provider_patch_document', ], 'nullable': [ ], @@ -5041,8 +5299,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_notification_channel_patch_document': - (JsonApiNotificationChannelPatchDocument,), + 'json_api_llm_provider_patch_document': + (JsonApiLlmProviderPatchDocument,), 'filter': (str,), }, @@ -5052,7 +5310,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_notification_channel_patch_document': 'body', + 'json_api_llm_provider_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -5070,24 +5328,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_organization_settings_endpoint = _Endpoint( + self.patch_entity_notification_channels_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), + 'response_type': (JsonApiNotificationChannelOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'patch_entity_organization_settings', + 'endpoint_path': '/api/v1/entities/notificationChannels/{id}', + 'operation_id': 'patch_entity_notification_channels', 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_organization_setting_patch_document', + 'json_api_notification_channel_patch_document', 'filter', ], 'required': [ 'id', - 'json_api_organization_setting_patch_document', + 'json_api_notification_channel_patch_document', ], 'nullable': [ ], @@ -5111,7 +5369,77 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_organization_setting_patch_document': + 'json_api_notification_channel_patch_document': + (JsonApiNotificationChannelPatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_notification_channel_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.patch_entity_organization_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrganizationSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', + 'operation_id': 'patch_entity_organization_settings', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_organization_setting_patch_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_organization_setting_patch_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_organization_setting_patch_document': (JsonApiOrganizationSettingPatchDocument,), 'filter': (str,), @@ -6018,6 +6346,76 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.update_entity_llm_providers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiLlmProviderOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmProviders/{id}', + 'operation_id': 'update_entity_llm_providers', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_llm_provider_in_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_llm_provider_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_llm_provider_in_document': + (JsonApiLlmProviderInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_llm_provider_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_notification_channels_endpoint = _Endpoint( settings={ 'response_type': (JsonApiNotificationChannelOutDocument,), @@ -7137,6 +7535,89 @@ def create_entity_llm_endpoints( json_api_llm_endpoint_in_document return self.create_entity_llm_endpoints_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_notification_channels( self, json_api_notification_channel_post_optional_id_document, @@ -8303,6 +8784,89 @@ def delete_entity_llm_endpoints( id return self.delete_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + def delete_entity_llm_providers( + self, + id, + **kwargs + ): + """Delete LLM Provider entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_llm_providers(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: + 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_llm_providers_endpoint.call_with_http_info(**kwargs) + def delete_entity_notification_channels( self, id, @@ -9390,7 +9954,90 @@ def get_all_entities_identity_providers( 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_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_jwks( + self, + **kwargs + ): + """Get all Jwks # noqa: E501 + + Returns all JSON web keys - used to verify JSON web tokens (Jwts) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_jwks(async_req=True) >>> result = thread.get() @@ -9432,7 +10079,7 @@ def get_all_entities_identity_providers( async_req (bool): execute request asynchronously Returns: - JsonApiIdentityProviderOutList + JsonApiJwkOutList If the method is called asynchronously, returns the request thread. """ @@ -9461,19 +10108,18 @@ 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_jwks_endpoint.call_with_http_info(**kwargs) - def get_all_entities_jwks( + def get_all_entities_llm_endpoints( self, **kwargs ): - """Get all Jwks # noqa: E501 + """Get all LLM endpoint entities # 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_llm_endpoints(async_req=True) >>> result = thread.get() @@ -9515,7 +10161,7 @@ def get_all_entities_jwks( async_req (bool): execute request asynchronously Returns: - JsonApiJwkOutList + JsonApiLlmEndpointOutList If the method is called asynchronously, returns the request thread. """ @@ -9544,18 +10190,18 @@ 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) + return self.get_all_entities_llm_endpoints_endpoint.call_with_http_info(**kwargs) - def get_all_entities_llm_endpoints( + def get_all_entities_llm_providers( self, **kwargs ): - """Get all LLM endpoint entities # 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_llm_endpoints(async_req=True) + >>> thread = api.get_all_entities_llm_providers(async_req=True) >>> result = thread.get() @@ -9597,7 +10243,7 @@ def get_all_entities_llm_endpoints( async_req (bool): execute request asynchronously Returns: - JsonApiLlmEndpointOutList + JsonApiLlmProviderOutList If the method is called asynchronously, returns the request thread. """ @@ -9626,7 +10272,7 @@ def get_all_entities_llm_endpoints( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_llm_endpoints_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_llm_providers_endpoint.call_with_http_info(**kwargs) def get_all_entities_notification_channel_identifiers( self, @@ -11127,6 +11773,89 @@ def get_entity_llm_endpoints( id return self.get_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + def get_entity_llm_providers( + self, + id, + **kwargs + ): + """Get 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.get_entity_llm_providers(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: + 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['id'] = \ + id + return self.get_entity_llm_providers_endpoint.call_with_http_info(**kwargs) + def get_entity_notification_channel_identifiers( self, id, @@ -12498,6 +13227,93 @@ def patch_entity_llm_endpoints( json_api_llm_endpoint_patch_document return self.patch_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + def patch_entity_llm_providers( + self, + id, + json_api_llm_provider_patch_document, + **kwargs + ): + """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_llm_providers(id, json_api_llm_provider_patch_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + 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] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a 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['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) + def patch_entity_notification_channels( self, id, @@ -13725,6 +14541,93 @@ def update_entity_llm_endpoints( json_api_llm_endpoint_in_document return self.update_entity_llm_endpoints_endpoint.call_with_http_info(**kwargs) + def update_entity_llm_providers( + self, + id, + json_api_llm_provider_in_document, + **kwargs + ): + """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_llm_providers(id, json_api_llm_provider_in_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + 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] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a 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['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_notification_channels( self, id, 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 10e2689f3..acd5cc343 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 @@ -35,6 +35,10 @@ from gooddata_api_client.model.clustering_result import ClusteringResult from gooddata_api_client.model.forecast_request import ForecastRequest from gooddata_api_client.model.forecast_result import ForecastResult +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_title_request import GenerateTitleRequest +from gooddata_api_client.model.generate_title_response import GenerateTitleResponse from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse from gooddata_api_client.model.memory_item_created_by_users import MemoryItemCreatedByUsers from gooddata_api_client.model.quality_issues_calculation_status_response import QualityIssuesCalculationStatusResponse @@ -42,6 +46,8 @@ 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_definition_request import TestLlmProviderDefinitionRequest +from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse from gooddata_api_client.model.trigger_quality_issues_calculation_response import TriggerQualityIssuesCalculationResponse from gooddata_api_client.model.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest from gooddata_api_client.model.validate_llm_endpoint_request import ValidateLLMEndpointRequest @@ -861,6 +867,132 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.generate_description_endpoint = _Endpoint( + settings={ + 'response_type': (GenerateDescriptionResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateDescription', + 'operation_id': 'generate_description', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'generate_description_request', + ], + 'required': [ + 'workspace_id', + 'generate_description_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,), + 'generate_description_request': + (GenerateDescriptionRequest,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'generate_description_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.generate_title_endpoint = _Endpoint( + settings={ + 'response_type': (GenerateTitleResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateTitle', + 'operation_id': 'generate_title', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'generate_title_request', + ], + 'required': [ + 'workspace_id', + 'generate_title_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,), + 'generate_title_request': + (GenerateTitleRequest,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'generate_title_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.get_quality_issues_endpoint = _Endpoint( settings={ 'response_type': (GetQualityIssuesResponse,), @@ -1147,6 +1279,105 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.test_llm_provider_endpoint = _Endpoint( + settings={ + 'response_type': (TestLlmProviderResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/ai/llmProvider/test', + 'operation_id': 'test_llm_provider', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'test_llm_provider_definition_request', + ], + 'required': [ + 'test_llm_provider_definition_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'test_llm_provider_definition_request': + (TestLlmProviderDefinitionRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'test_llm_provider_definition_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.test_llm_provider_by_id_endpoint = _Endpoint( + settings={ + 'response_type': (TestLlmProviderResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/ai/llmProvider/{llmProviderId}/test', + 'operation_id': 'test_llm_provider_by_id', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'llm_provider_id', + ], + 'required': [ + 'llm_provider_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'llm_provider_id': + (str,), + }, + 'attribute_map': { + 'llm_provider_id': 'llmProviderId', + }, + 'location_map': { + 'llm_provider_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.trigger_quality_issues_calculation_endpoint = _Endpoint( settings={ 'response_type': (TriggerQualityIssuesCalculationResponse,), @@ -2366,6 +2597,180 @@ def forecast_result( result_id return self.forecast_result_endpoint.call_with_http_info(**kwargs) + def generate_description( + self, + workspace_id, + generate_description_request, + **kwargs + ): + """Generate Description for Analytics Object # noqa: E501 + + Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed. # 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_description(workspace_id, generate_description_request, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): Workspace identifier + generate_description_request (GenerateDescriptionRequest): + + 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: + GenerateDescriptionResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', 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['generate_description_request'] = \ + generate_description_request + return self.generate_description_endpoint.call_with_http_info(**kwargs) + + def generate_title( + self, + workspace_id, + generate_title_request, + **kwargs + ): + """Generate Title for Analytics Object # noqa: E501 + + Generates a title for the specified analytics object. Returns title and a note with details if generation was not performed. # 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_title(workspace_id, generate_title_request, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): Workspace identifier + generate_title_request (GenerateTitleRequest): + + 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: + GenerateTitleResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', 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['generate_title_request'] = \ + generate_title_request + return self.generate_title_endpoint.call_with_http_info(**kwargs) + def get_quality_issues( self, workspace_id, @@ -2785,6 +3190,172 @@ def tags( workspace_id return self.tags_endpoint.call_with_http_info(**kwargs) + def test_llm_provider( + self, + test_llm_provider_definition_request, + **kwargs + ): + """Test LLM Provider # noqa: E501 + + Tests LLM provider connectivity with a full 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.test_llm_provider(test_llm_provider_definition_request, async_req=True) + >>> result = thread.get() + + Args: + test_llm_provider_definition_request (TestLlmProviderDefinitionRequest): + + 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: + TestLlmProviderResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['test_llm_provider_definition_request'] = \ + test_llm_provider_definition_request + return self.test_llm_provider_endpoint.call_with_http_info(**kwargs) + + def test_llm_provider_by_id( + self, + llm_provider_id, + **kwargs + ): + """Test LLM Provider By Id # noqa: E501 + + Tests an existing LLM provider connectivity by its ID. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.test_llm_provider_by_id(llm_provider_id, async_req=True) + >>> result = thread.get() + + Args: + llm_provider_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: + TestLlmProviderResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['llm_provider_id'] = \ + llm_provider_id + return self.test_llm_provider_by_id_endpoint.call_with_http_info(**kwargs) + def trigger_quality_issues_calculation( self, workspace_id, 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 619f56bed..917c6c617 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 @@ -88,6 +88,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -251,6 +252,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -367,6 +369,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -464,6 +467,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, @@ -626,6 +630,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, diff --git a/gooddata-api-client/gooddata_api_client/api/workspace_object_controller_api.py b/gooddata-api-client/gooddata_api_client/api/workspace_object_controller_api.py index d007ddc2f..9cfa5864e 100644 --- a/gooddata-api-client/gooddata_api_client/api/workspace_object_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/workspace_object_controller_api.py @@ -175,6 +175,7 @@ def __init__(self, api_client=None): "DASHBOARDPLUGINS": "dashboardPlugins", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -1058,6 +1059,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -1247,6 +1249,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -2654,6 +2657,7 @@ def __init__(self, api_client=None): "DASHBOARDPLUGINS": "dashboardPlugins", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -4346,6 +4350,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -4597,6 +4602,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -5157,6 +5163,7 @@ def __init__(self, api_client=None): "DASHBOARDPLUGINS": "dashboardPlugins", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -6511,6 +6518,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -6716,6 +6724,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -7090,6 +7099,7 @@ def __init__(self, api_client=None): "DASHBOARDPLUGINS": "dashboardPlugins", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, @@ -8263,6 +8273,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, @@ -8440,6 +8451,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, @@ -10391,6 +10403,7 @@ def __init__(self, api_client=None): "DASHBOARDPLUGINS": "dashboardPlugins", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, @@ -11229,6 +11242,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, @@ -11406,6 +11420,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, }, diff --git a/gooddata-api-client/gooddata_api_client/api_client.py b/gooddata-api-client/gooddata_api_client/api_client.py index dbb71b472..15f1703cc 100644 --- a/gooddata-api-client/gooddata_api_client/api_client.py +++ b/gooddata-api-client/gooddata_api_client/api_client.py @@ -287,8 +287,10 @@ def sanitize_for_serialization(cls, obj): return obj.isoformat() elif isinstance(obj, ModelSimple): return cls.sanitize_for_serialization(obj.value) - elif isinstance(obj, (list, tuple)): + elif isinstance(obj, list): return [cls.sanitize_for_serialization(item) for item in obj] + elif isinstance(obj, tuple): + return tuple(cls.sanitize_for_serialization(item) for item in obj) if isinstance(obj, dict): return {key: cls.sanitize_for_serialization(val) for key, val in obj.items()} raise ApiValueError( diff --git a/gooddata-api-client/gooddata_api_client/apis/__init__.py b/gooddata-api-client/gooddata_api_client/apis/__init__.py index be24be63c..ef0cc377b 100644 --- a/gooddata-api-client/gooddata_api_client/apis/__init__.py +++ b/gooddata-api-client/gooddata_api_client/apis/__init__.py @@ -26,6 +26,7 @@ from gooddata_api_client.api.automations_api import AutomationsApi from gooddata_api_client.api.available_drivers_api import AvailableDriversApi from gooddata_api_client.api.csp_directives_api import CSPDirectivesApi +from gooddata_api_client.api.certification_api import CertificationApi from gooddata_api_client.api.computation_api import ComputationApi from gooddata_api_client.api.cookie_security_configuration_api import CookieSecurityConfigurationApi from gooddata_api_client.api.dashboards_api import DashboardsApi @@ -49,6 +50,7 @@ from gooddata_api_client.api.jwks_api import JWKSApi 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.metadata_check_api import MetadataCheckApi diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_aac_workspaces_workspace_id_analytics_model.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_aac_workspaces_workspace_id_analytics_model.py new file mode 100644 index 000000000..781665585 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_aac_workspaces_workspace_id_analytics_model.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_aac_workspaces_workspace_id_analytics_model.get import ApiForget +from gooddata_api_client.paths.api_v1_aac_workspaces_workspace_id_analytics_model.put import ApiForput + + +class ApiV1AacWorkspacesWorkspaceIdAnalyticsModel( + ApiForget, + ApiForput, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_aac_workspaces_workspace_id_logical_model.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_aac_workspaces_workspace_id_logical_model.py new file mode 100644 index 000000000..ca0ea4c84 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_aac_workspaces_workspace_id_logical_model.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_aac_workspaces_workspace_id_logical_model.get import ApiForget +from gooddata_api_client.paths.api_v1_aac_workspaces_workspace_id_logical_model.put import ApiForput + + +class ApiV1AacWorkspacesWorkspaceIdLogicalModel( + ApiForget, + ApiForput, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_ai_llm_endpoint_llm_endpoint_id_test.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_ai_llm_endpoint_llm_endpoint_id_test.py new file mode 100644 index 000000000..fd855eed9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_ai_llm_endpoint_llm_endpoint_id_test.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_ai_llm_endpoint_llm_endpoint_id_test.post import ApiForpost + + +class ApiV1ActionsAiLlmEndpointLlmEndpointIdTest( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_ai_llm_endpoint_test.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_ai_llm_endpoint_test.py new file mode 100644 index 000000000..919746739 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_ai_llm_endpoint_test.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_ai_llm_endpoint_test.post import ApiForpost + + +class ApiV1ActionsAiLlmEndpointTest( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_ai_llm_provider_llm_provider_id_test.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_ai_llm_provider_llm_provider_id_test.py new file mode 100644 index 000000000..e7dfa2046 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_ai_llm_provider_llm_provider_id_test.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_ai_llm_provider_llm_provider_id_test.post import ApiForpost + + +class ApiV1ActionsAiLlmProviderLlmProviderIdTest( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_ai_llm_provider_test.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_ai_llm_provider_test.py new file mode 100644 index 000000000..727216a8a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_ai_llm_provider_test.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_ai_llm_provider_test.post import ApiForpost + + +class ApiV1ActionsAiLlmProviderTest( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_data_sources_data_source_id_compute_column_statistics.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_data_sources_data_source_id_compute_column_statistics.py new file mode 100644 index 000000000..e2dca9b4e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_data_sources_data_source_id_compute_column_statistics.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_data_sources_data_source_id_compute_column_statistics.post import ApiForpost + + +class ApiV1ActionsDataSourcesDataSourceIdComputeColumnStatistics( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model_aac.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model_aac.py new file mode 100644 index 000000000..ea0b2e430 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model_aac.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_data_sources_data_source_id_generate_logical_model_aac.post import ApiForpost + + +class ApiV1ActionsDataSourcesDataSourceIdGenerateLogicalModelAac( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_data_sources_data_source_id_manage_permissions.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_data_sources_data_source_id_manage_permissions.py new file mode 100644 index 000000000..b46fb7522 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_data_sources_data_source_id_manage_permissions.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_data_sources_data_source_id_manage_permissions.post import ApiForpost + + +class ApiV1ActionsDataSourcesDataSourceIdManagePermissions( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_notification_channels_notification_channel_id_test.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_notification_channels_notification_channel_id_test.py new file mode 100644 index 000000000..2df8af21f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_notification_channels_notification_channel_id_test.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_notification_channels_notification_channel_id_test.post import ApiForpost + + +class ApiV1ActionsNotificationChannelsNotificationChannelIdTest( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_notification_channels_test.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_notification_channels_test.py new file mode 100644 index 000000000..7a05c6b1e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_notification_channels_test.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_notification_channels_test.post import ApiForpost + + +class ApiV1ActionsNotificationChannelsTest( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_notifications.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_notifications.py new file mode 100644 index 000000000..46a0a3a5b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_notifications.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_notifications.get import ApiForget + + +class ApiV1ActionsNotifications( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_notifications_mark_as_read.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_notifications_mark_as_read.py new file mode 100644 index 000000000..1ba1b8c2c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_notifications_mark_as_read.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_notifications_mark_as_read.post import ApiForpost + + +class ApiV1ActionsNotificationsMarkAsRead( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_notifications_notification_id_mark_as_read.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_notifications_notification_id_mark_as_read.py new file mode 100644 index 000000000..f93271a57 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_notifications_notification_id_mark_as_read.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_notifications_notification_id_mark_as_read.post import ApiForpost + + +class ApiV1ActionsNotificationsNotificationIdMarkAsRead( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_automations_delete.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_automations_delete.py new file mode 100644 index 000000000..df1400f45 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_automations_delete.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_organization_automations_delete.post import ApiForpost + + +class ApiV1ActionsOrganizationAutomationsDelete( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_automations_pause.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_automations_pause.py new file mode 100644 index 000000000..40b927b82 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_automations_pause.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_organization_automations_pause.post import ApiForpost + + +class ApiV1ActionsOrganizationAutomationsPause( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_automations_unpause.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_automations_unpause.py new file mode 100644 index 000000000..80bac0ab0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_automations_unpause.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_organization_automations_unpause.post import ApiForpost + + +class ApiV1ActionsOrganizationAutomationsUnpause( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_automations_unsubscribe.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_automations_unsubscribe.py new file mode 100644 index 000000000..063461cd3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_automations_unsubscribe.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_actions_organization_automations_unsubscribe.post import ApiForpost +from gooddata_api_client.paths.api_v1_actions_organization_automations_unsubscribe.delete import ApiFordelete + + +class ApiV1ActionsOrganizationAutomationsUnsubscribe( + ApiForpost, + ApiFordelete, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_manage_permissions.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_manage_permissions.py new file mode 100644 index 000000000..ad0ff2ed6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_manage_permissions.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_organization_manage_permissions.post import ApiForpost + + +class ApiV1ActionsOrganizationManagePermissions( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_metadata_check.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_metadata_check.py new file mode 100644 index 000000000..962069e8d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_metadata_check.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_organization_metadata_check.post import ApiForpost + + +class ApiV1ActionsOrganizationMetadataCheck( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_metadata_sync.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_metadata_sync.py new file mode 100644 index 000000000..b0df1da84 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_metadata_sync.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_organization_metadata_sync.post import ApiForpost + + +class ApiV1ActionsOrganizationMetadataSync( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_switch_active_identity_provider.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_switch_active_identity_provider.py new file mode 100644 index 000000000..a0446b24d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_organization_switch_active_identity_provider.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_organization_switch_active_identity_provider.post import ApiForpost + + +class ApiV1ActionsOrganizationSwitchActiveIdentityProvider( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_assign_permissions.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_assign_permissions.py new file mode 100644 index 000000000..fee69b01c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_assign_permissions.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_user_management_assign_permissions.post import ApiForpost + + +class ApiV1ActionsUserManagementAssignPermissions( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_remove_users_user_groups.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_remove_users_user_groups.py new file mode 100644 index 000000000..eaef7d93d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_remove_users_user_groups.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_user_management_remove_users_user_groups.post import ApiForpost + + +class ApiV1ActionsUserManagementRemoveUsersUserGroups( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_revoke_permissions.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_revoke_permissions.py new file mode 100644 index 000000000..8ab70ae10 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_revoke_permissions.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_user_management_revoke_permissions.post import ApiForpost + + +class ApiV1ActionsUserManagementRevokePermissions( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_user_groups.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_user_groups.py new file mode 100644 index 000000000..c397d54f9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_user_groups.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_user_management_user_groups.get import ApiForget + + +class ApiV1ActionsUserManagementUserGroups( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_user_groups_user_group_id_add_members.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_user_groups_user_group_id_add_members.py new file mode 100644 index 000000000..c021041c6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_user_groups_user_group_id_add_members.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_user_management_user_groups_user_group_id_add_members.post import ApiForpost + + +class ApiV1ActionsUserManagementUserGroupsUserGroupIdAddMembers( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_user_groups_user_group_id_members.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_user_groups_user_group_id_members.py new file mode 100644 index 000000000..f79b284a8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_user_groups_user_group_id_members.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_user_management_user_groups_user_group_id_members.get import ApiForget + + +class ApiV1ActionsUserManagementUserGroupsUserGroupIdMembers( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions.py new file mode 100644 index 000000000..03f45e5ee --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_actions_user_management_user_groups_user_group_id_permissions.get import ApiForget +from gooddata_api_client.paths.api_v1_actions_user_management_user_groups_user_group_id_permissions.post import ApiForpost + + +class ApiV1ActionsUserManagementUserGroupsUserGroupIdPermissions( + ApiForget, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_user_groups_user_group_id_remove_members.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_user_groups_user_group_id_remove_members.py new file mode 100644 index 000000000..4d03f3797 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_user_groups_user_group_id_remove_members.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_user_management_user_groups_user_group_id_remove_members.post import ApiForpost + + +class ApiV1ActionsUserManagementUserGroupsUserGroupIdRemoveMembers( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_users.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_users.py new file mode 100644 index 000000000..885ad63b3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_users.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_user_management_users.get import ApiForget + + +class ApiV1ActionsUserManagementUsers( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_users_user_id_permissions.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_users_user_id_permissions.py new file mode 100644 index 000000000..8413f0d42 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_user_management_users_user_id_permissions.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_actions_user_management_users_user_id_permissions.get import ApiForget +from gooddata_api_client.paths.api_v1_actions_user_management_users_user_id_permissions.post import ApiForpost + + +class ApiV1ActionsUserManagementUsersUserIdPermissions( + ApiForget, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_created_by.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_created_by.py new file mode 100644 index 000000000..8488caeb7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_created_by.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_created_by.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdAiAnalyticsCatalogCreatedBy( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_description.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_description.py new file mode 100644 index 000000000..76d53f624 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_description.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_description.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdAiAnalyticsCatalogGenerateDescription( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_title.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_title.py new file mode 100644 index 000000000..feeb51016 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_title.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_title.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdAiAnalyticsCatalogGenerateTitle( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_tags.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_tags.py new file mode 100644 index 000000000..520a2c7ec --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_tags.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_tags.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdAiAnalyticsCatalogTags( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_chat.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_chat.py new file mode 100644 index 000000000..3e06c0c43 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_chat.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_chat.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdAiChat( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_chat_history.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_chat_history.py new file mode 100644 index 000000000..63c30aa3f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_chat_history.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_chat_history.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdAiChatHistory( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_chat_stream.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_chat_stream.py new file mode 100644 index 000000000..a19ffbaf7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_chat_stream.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_chat_stream.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdAiChatStream( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_chat_usage.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_chat_usage.py new file mode 100644 index 000000000..cf8f0bab7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_chat_usage.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_chat_usage.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdAiChatUsage( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_issues.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_issues.py new file mode 100644 index 000000000..e81227acc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_issues.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_issues.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdAiIssues( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_issues_status_process_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_issues_status_process_id.py new file mode 100644 index 000000000..16ca9eadf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_issues_status_process_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_issues_status_process_id.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdAiIssuesStatusProcessId( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_issues_trigger_check.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_issues_trigger_check.py new file mode 100644 index 000000000..21b2cc243 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_issues_trigger_check.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_issues_trigger_check.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdAiIssuesTriggerCheck( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents.py new file mode 100644 index 000000000..7d35f629e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents.py @@ -0,0 +1,11 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_knowledge_documents.get import ApiForget +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_knowledge_documents.put import ApiForput +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_knowledge_documents.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdAiKnowledgeDocuments( + ApiForget, + ApiForput, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename.py new file mode 100644 index 000000000..10b590b17 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename.py @@ -0,0 +1,11 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename.get import ApiForget +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename.delete import ApiFordelete +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename.patch import ApiForpatch + + +class ApiV1ActionsWorkspacesWorkspaceIdAiKnowledgeDocumentsFilename( + ApiForget, + ApiFordelete, + ApiForpatch, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_search.py new file mode 100644 index 000000000..d8df5a09c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_knowledge_search.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdAiKnowledgeSearch( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_memory_created_by.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_memory_created_by.py new file mode 100644 index 000000000..628385c2a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_memory_created_by.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_memory_created_by.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdAiMemoryCreatedBy( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_resolve_llm_endpoints.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_resolve_llm_endpoints.py new file mode 100644 index 000000000..be25bcbdf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_resolve_llm_endpoints.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_resolve_llm_endpoints.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdAiResolveLlmEndpoints( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_search.py new file mode 100644 index 000000000..453633e57 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_ai_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_search.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdAiSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_export_tabular.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_export_tabular.py new file mode 100644 index 000000000..fdc337707 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_export_tabular.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_export_tabular.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdAnalyticalDashboardsDashboardIdExportTabular( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_trigger.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_trigger.py new file mode 100644 index 000000000..3058cfaf8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_trigger.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_automation_id_trigger.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdAutomationsAutomationIdTrigger( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_unsubscribe.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_unsubscribe.py new file mode 100644 index 000000000..2e97e52a5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_unsubscribe.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_automation_id_unsubscribe.delete import ApiFordelete + + +class ApiV1ActionsWorkspacesWorkspaceIdAutomationsAutomationIdUnsubscribe( + ApiFordelete, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_delete.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_delete.py new file mode 100644 index 000000000..8ab8af485 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_delete.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_delete.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdAutomationsDelete( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_pause.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_pause.py new file mode 100644 index 000000000..c3e2d9d9d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_pause.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_pause.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdAutomationsPause( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_trigger.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_trigger.py new file mode 100644 index 000000000..f5599db33 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_trigger.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_trigger.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdAutomationsTrigger( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_unpause.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_unpause.py new file mode 100644 index 000000000..cd16c376b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_unpause.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_unpause.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdAutomationsUnpause( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe.py new file mode 100644 index 000000000..093f90f01 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_unsubscribe.post import ApiForpost +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_unsubscribe.delete import ApiFordelete + + +class ApiV1ActionsWorkspacesWorkspaceIdAutomationsUnsubscribe( + ApiForpost, + ApiFordelete, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_afm_cancel.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_afm_cancel.py new file mode 100644 index 000000000..3a33bf568 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_afm_cancel.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_afm_cancel.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdExecutionAfmCancel( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_descendants.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_descendants.py new file mode 100644 index 000000000..f028d3e82 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_descendants.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_descendants.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdExecutionAfmComputeValidDescendants( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis.py new file mode 100644 index 000000000..86dd925c2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdExecutionComputeChangeAnalysis( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis_result_result_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis_result_result_id.py new file mode 100644 index 000000000..f724ea8e2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis_result_result_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis_result_result_id.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdExecutionComputeChangeAnalysisResultResultId( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers.py new file mode 100644 index 000000000..63d425ba9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdExecutionComputeKeyDrivers( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers_result_result_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers_result_result_id.py new file mode 100644 index 000000000..88398b6b5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers_result_result_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers_result_result_id.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdExecutionComputeKeyDriversResultResultId( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers.py new file mode 100644 index 000000000..86de70fff --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_detect_outliers.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdExecutionDetectOutliers( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers_result_result_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers_result_result_id.py new file mode 100644 index 000000000..2d455ed20 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers_result_result_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_detect_outliers_result_result_id.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdExecutionDetectOutliersResultResultId( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_id.py new file mode 100644 index 000000000..94adf120d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_id.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdExecutionFunctionsAnomalyDetectionResultId( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_result_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_result_id.py new file mode 100644 index 000000000..929764f5b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_result_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_result_id.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdExecutionFunctionsAnomalyDetectionResultResultId( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_id.py new file mode 100644 index 000000000..99a5df64d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_id.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdExecutionFunctionsClusteringResultId( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_result_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_result_id.py new file mode 100644 index 000000000..ea91a8106 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_result_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_result_id.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdExecutionFunctionsClusteringResultResultId( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_id.py new file mode 100644 index 000000000..80714abd8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_id.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdExecutionFunctionsForecastResultId( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_result_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_result_id.py new file mode 100644 index 000000000..f0287842d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_result_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_result_id.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdExecutionFunctionsForecastResultResultId( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_image.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_image.py new file mode 100644 index 000000000..50c189b34 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_image.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_image.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdExportImage( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id.py new file mode 100644 index 000000000..370eb8c69 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_image_export_id.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdExportImageExportId( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id_metadata.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id_metadata.py new file mode 100644 index 000000000..73f97fc17 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id_metadata.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_image_export_id_metadata.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdExportImageExportIdMetadata( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_raw.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_raw.py new file mode 100644 index 000000000..57a7468cb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_raw.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_raw.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdExportRaw( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_raw_export_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_raw_export_id.py new file mode 100644 index 000000000..fa3958057 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_raw_export_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_raw_export_id.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdExportRawExportId( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_slides.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_slides.py new file mode 100644 index 000000000..abad6c49b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_slides.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_slides.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdExportSlides( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id.py new file mode 100644 index 000000000..9b5509385 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_slides_export_id.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdExportSlidesExportId( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id_metadata.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id_metadata.py new file mode 100644 index 000000000..8900487ac --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id_metadata.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_slides_export_id_metadata.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdExportSlidesExportIdMetadata( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_prefixes.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_prefixes.py new file mode 100644 index 000000000..68ee67716 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_prefixes.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_inherited_entity_prefixes.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdInheritedEntityPrefixes( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_manage_permissions.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_manage_permissions.py new file mode 100644 index 000000000..6399120ea --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_manage_permissions.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_manage_permissions.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdManagePermissions( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_metadata_sync.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_metadata_sync.py new file mode 100644 index 000000000..a7a79ad0b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_metadata_sync.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_metadata_sync.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdMetadataSync( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_set_certification.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_set_certification.py new file mode 100644 index 000000000..0bda19e1e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_set_certification.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_set_certification.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdSetCertification( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_translations.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_translations.py new file mode 100644 index 000000000..c91557a20 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_translations.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_translations.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdTranslations( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_translations_clean.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_translations_clean.py new file mode 100644 index 000000000..92ea362d0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_translations_clean.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_translations_clean.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdTranslationsClean( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_translations_retrieve.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_translations_retrieve.py new file mode 100644 index 000000000..12a504f53 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_translations_retrieve.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_translations_retrieve.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdTranslationsRetrieve( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_translations_set.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_translations_set.py new file mode 100644 index 000000000..4d3a439a5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_translations_set.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_translations_set.post import ApiForpost + + +class ApiV1ActionsWorkspacesWorkspaceIdTranslationsSet( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_user_groups.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_user_groups.py new file mode 100644 index 000000000..a430d004f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_user_groups.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_user_groups.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdUserGroups( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_users.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_users.py new file mode 100644 index 000000000..20092108c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_actions_workspaces_workspace_id_users.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_users.get import ApiForget + + +class ApiV1ActionsWorkspacesWorkspaceIdUsers( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_ailake_database_instances.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_ailake_database_instances.py new file mode 100644 index 000000000..63326be81 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_ailake_database_instances.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_ailake_database_instances.get import ApiForget +from gooddata_api_client.paths.api_v1_ailake_database_instances.post import ApiForpost + + +class ApiV1AilakeDatabaseInstances( + ApiForget, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_ailake_database_instances_instance_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_ailake_database_instances_instance_id.py new file mode 100644 index 000000000..86a4564ce --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_ailake_database_instances_instance_id.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_ailake_database_instances_instance_id.get import ApiForget +from gooddata_api_client.paths.api_v1_ailake_database_instances_instance_id.delete import ApiFordelete + + +class ApiV1AilakeDatabaseInstancesInstanceId( + ApiForget, + ApiFordelete, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_ailake_operations_operation_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_ailake_operations_operation_id.py new file mode 100644 index 000000000..49c8369c5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_ailake_operations_operation_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_ailake_operations_operation_id.get import ApiForget + + +class ApiV1AilakeOperationsOperationId( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_ailake_services.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_ailake_services.py new file mode 100644 index 000000000..958b029b2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_ailake_services.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_ailake_services.get import ApiForget + + +class ApiV1AilakeServices( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_ailake_services_service_id_commands_command_name_run.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_ailake_services_service_id_commands_command_name_run.py new file mode 100644 index 000000000..b761960f2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_ailake_services_service_id_commands_command_name_run.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_ailake_services_service_id_commands_command_name_run.post import ApiForpost + + +class ApiV1AilakeServicesServiceIdCommandsCommandNameRun( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_custom_geo_collections.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_custom_geo_collections.py new file mode 100644 index 000000000..784a8a5d0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_custom_geo_collections.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_entities_custom_geo_collections.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_custom_geo_collections.post import ApiForpost + + +class ApiV1EntitiesCustomGeoCollections( + ApiForget, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_custom_geo_collections_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_custom_geo_collections_id.py new file mode 100644 index 000000000..52375d946 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_custom_geo_collections_id.py @@ -0,0 +1,13 @@ +from gooddata_api_client.paths.api_v1_entities_custom_geo_collections_id.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_custom_geo_collections_id.put import ApiForput +from gooddata_api_client.paths.api_v1_entities_custom_geo_collections_id.delete import ApiFordelete +from gooddata_api_client.paths.api_v1_entities_custom_geo_collections_id.patch import ApiForpatch + + +class ApiV1EntitiesCustomGeoCollectionsId( + ApiForget, + ApiForput, + ApiFordelete, + ApiForpatch, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_export_templates.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_export_templates.py new file mode 100644 index 000000000..fa800757e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_export_templates.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_entities_export_templates.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_export_templates.post import ApiForpost + + +class ApiV1EntitiesExportTemplates( + ApiForget, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_export_templates_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_export_templates_id.py new file mode 100644 index 000000000..836cac2b3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_export_templates_id.py @@ -0,0 +1,13 @@ +from gooddata_api_client.paths.api_v1_entities_export_templates_id.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_export_templates_id.put import ApiForput +from gooddata_api_client.paths.api_v1_entities_export_templates_id.delete import ApiFordelete +from gooddata_api_client.paths.api_v1_entities_export_templates_id.patch import ApiForpatch + + +class ApiV1EntitiesExportTemplatesId( + ApiForget, + ApiForput, + ApiFordelete, + ApiForpatch, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_identity_providers.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_identity_providers.py new file mode 100644 index 000000000..501fa5978 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_identity_providers.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_entities_identity_providers.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_identity_providers.post import ApiForpost + + +class ApiV1EntitiesIdentityProviders( + ApiForget, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_identity_providers_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_identity_providers_id.py new file mode 100644 index 000000000..badd980ea --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_identity_providers_id.py @@ -0,0 +1,13 @@ +from gooddata_api_client.paths.api_v1_entities_identity_providers_id.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_identity_providers_id.put import ApiForput +from gooddata_api_client.paths.api_v1_entities_identity_providers_id.delete import ApiFordelete +from gooddata_api_client.paths.api_v1_entities_identity_providers_id.patch import ApiForpatch + + +class ApiV1EntitiesIdentityProvidersId( + ApiForget, + ApiForput, + ApiFordelete, + ApiForpatch, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_jwks.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_jwks.py new file mode 100644 index 000000000..f46400a65 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_jwks.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_entities_jwks.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_jwks.post import ApiForpost + + +class ApiV1EntitiesJwks( + ApiForget, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_jwks_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_jwks_id.py new file mode 100644 index 000000000..1f060dde1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_jwks_id.py @@ -0,0 +1,13 @@ +from gooddata_api_client.paths.api_v1_entities_jwks_id.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_jwks_id.put import ApiForput +from gooddata_api_client.paths.api_v1_entities_jwks_id.delete import ApiFordelete +from gooddata_api_client.paths.api_v1_entities_jwks_id.patch import ApiForpatch + + +class ApiV1EntitiesJwksId( + ApiForget, + ApiForput, + ApiFordelete, + ApiForpatch, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_llm_endpoints.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_llm_endpoints.py new file mode 100644 index 000000000..54d5ef112 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_llm_endpoints.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_entities_llm_endpoints.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_llm_endpoints.post import ApiForpost + + +class ApiV1EntitiesLlmEndpoints( + ApiForget, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_llm_endpoints_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_llm_endpoints_id.py new file mode 100644 index 000000000..7326810cd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_llm_endpoints_id.py @@ -0,0 +1,13 @@ +from gooddata_api_client.paths.api_v1_entities_llm_endpoints_id.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_llm_endpoints_id.put import ApiForput +from gooddata_api_client.paths.api_v1_entities_llm_endpoints_id.delete import ApiFordelete +from gooddata_api_client.paths.api_v1_entities_llm_endpoints_id.patch import ApiForpatch + + +class ApiV1EntitiesLlmEndpointsId( + ApiForget, + ApiForput, + ApiFordelete, + ApiForpatch, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_llm_providers.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_llm_providers.py new file mode 100644 index 000000000..e049b3357 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_llm_providers.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_entities_llm_providers.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_llm_providers.post import ApiForpost + + +class ApiV1EntitiesLlmProviders( + ApiForget, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_llm_providers_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_llm_providers_id.py new file mode 100644 index 000000000..b776f2eb1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_llm_providers_id.py @@ -0,0 +1,13 @@ +from gooddata_api_client.paths.api_v1_entities_llm_providers_id.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_llm_providers_id.put import ApiForput +from gooddata_api_client.paths.api_v1_entities_llm_providers_id.delete import ApiFordelete +from gooddata_api_client.paths.api_v1_entities_llm_providers_id.patch import ApiForpatch + + +class ApiV1EntitiesLlmProvidersId( + ApiForget, + ApiForput, + ApiFordelete, + ApiForpatch, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_notification_channel_identifiers.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_notification_channel_identifiers.py new file mode 100644 index 000000000..55bb09dc6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_notification_channel_identifiers.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_notification_channel_identifiers.get import ApiForget + + +class ApiV1EntitiesNotificationChannelIdentifiers( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_notification_channel_identifiers_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_notification_channel_identifiers_id.py new file mode 100644 index 000000000..55c161b0c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_notification_channel_identifiers_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_notification_channel_identifiers_id.get import ApiForget + + +class ApiV1EntitiesNotificationChannelIdentifiersId( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_notification_channels.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_notification_channels.py new file mode 100644 index 000000000..e0b3319ad --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_notification_channels.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_entities_notification_channels.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_notification_channels.post import ApiForpost + + +class ApiV1EntitiesNotificationChannels( + ApiForget, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_notification_channels_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_notification_channels_id.py new file mode 100644 index 000000000..0d133cf96 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_notification_channels_id.py @@ -0,0 +1,13 @@ +from gooddata_api_client.paths.api_v1_entities_notification_channels_id.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_notification_channels_id.put import ApiForput +from gooddata_api_client.paths.api_v1_entities_notification_channels_id.delete import ApiFordelete +from gooddata_api_client.paths.api_v1_entities_notification_channels_id.patch import ApiForpatch + + +class ApiV1EntitiesNotificationChannelsId( + ApiForget, + ApiForput, + ApiFordelete, + ApiForpatch, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_organization_workspace_automations.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_organization_workspace_automations.py new file mode 100644 index 000000000..cc8c7050a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_organization_workspace_automations.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_organization_workspace_automations.get import ApiForget + + +class ApiV1EntitiesOrganizationWorkspaceAutomations( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_user_identifiers.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_user_identifiers.py new file mode 100644 index 000000000..3fdf346fc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_user_identifiers.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_user_identifiers.get import ApiForget + + +class ApiV1EntitiesUserIdentifiers( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_user_identifiers_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_user_identifiers_id.py new file mode 100644 index 000000000..d528cecd7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_user_identifiers_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_user_identifiers_id.get import ApiForget + + +class ApiV1EntitiesUserIdentifiersId( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts.py new file mode 100644 index 000000000..5053d52dc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_aggregated_facts.get import ApiForget + + +class ApiV1EntitiesWorkspacesWorkspaceIdAggregatedFacts( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_object_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_object_id.py new file mode 100644 index 000000000..0b8d0067b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_object_id.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_aggregated_facts_object_id.get import ApiForget + + +class ApiV1EntitiesWorkspacesWorkspaceIdAggregatedFactsObjectId( + ApiForget, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_search.py new file mode 100644 index 000000000..26b321dba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_aggregated_facts_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdAggregatedFactsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_search.py new file mode 100644 index 000000000..ffd9c92c5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_analytical_dashboards_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdAnalyticalDashboardsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies.py new file mode 100644 index 000000000..c73735d2c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdAttributeHierarchies( + ApiForget, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id.py new file mode 100644 index 000000000..1c12913ba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id.py @@ -0,0 +1,13 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id.put import ApiForput +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id.delete import ApiFordelete +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id.patch import ApiForpatch + + +class ApiV1EntitiesWorkspacesWorkspaceIdAttributeHierarchiesObjectId( + ApiForget, + ApiForput, + ApiFordelete, + ApiForpatch, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_search.py new file mode 100644 index 000000000..c4ec77f5f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdAttributeHierarchiesSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_attributes_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_attributes_search.py new file mode 100644 index 000000000..cea9fcc35 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_attributes_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attributes_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdAttributesSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_automation_results_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_automation_results_search.py new file mode 100644 index 000000000..c1898356a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_automation_results_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automation_results_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdAutomationResultsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_automations.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_automations.py new file mode 100644 index 000000000..83b85d452 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_automations.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdAutomations( + ApiForget, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_automations_object_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_automations_object_id.py new file mode 100644 index 000000000..301f11474 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_automations_object_id.py @@ -0,0 +1,13 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations_object_id.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations_object_id.put import ApiForput +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations_object_id.delete import ApiFordelete +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations_object_id.patch import ApiForpatch + + +class ApiV1EntitiesWorkspacesWorkspaceIdAutomationsObjectId( + ApiForget, + ApiForput, + ApiFordelete, + ApiForpatch, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_automations_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_automations_search.py new file mode 100644 index 000000000..76b347b27 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_automations_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdAutomationsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_search.py new file mode 100644 index 000000000..4afb2f397 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_custom_application_settings_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdCustomApplicationSettingsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_search.py new file mode 100644 index 000000000..46f8e3bcf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_dashboard_plugins_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdDashboardPluginsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_datasets_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_datasets_search.py new file mode 100644 index 000000000..839db8db9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_datasets_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_datasets_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdDatasetsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_export_definitions.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_export_definitions.py new file mode 100644 index 000000000..9ae8ed0dd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_export_definitions.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdExportDefinitions( + ApiForget, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id.py new file mode 100644 index 000000000..d4e1080b1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id.py @@ -0,0 +1,13 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions_object_id.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions_object_id.put import ApiForput +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions_object_id.delete import ApiFordelete +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions_object_id.patch import ApiForpatch + + +class ApiV1EntitiesWorkspacesWorkspaceIdExportDefinitionsObjectId( + ApiForget, + ApiForput, + ApiFordelete, + ApiForpatch, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_export_definitions_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_export_definitions_search.py new file mode 100644 index 000000000..eab1b86f1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_export_definitions_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdExportDefinitionsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_facts_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_facts_search.py new file mode 100644 index 000000000..33b65ef9a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_facts_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_facts_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdFactsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_search.py new file mode 100644 index 000000000..326b5efb8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_contexts_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdFilterContextsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_filter_views.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_filter_views.py new file mode 100644 index 000000000..bf85f33e4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_filter_views.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdFilterViews( + ApiForget, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id.py new file mode 100644 index 000000000..735486d62 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id.py @@ -0,0 +1,13 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views_object_id.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views_object_id.put import ApiForput +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views_object_id.delete import ApiFordelete +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views_object_id.patch import ApiForpatch + + +class ApiV1EntitiesWorkspacesWorkspaceIdFilterViewsObjectId( + ApiForget, + ApiForput, + ApiFordelete, + ApiForpatch, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_filter_views_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_filter_views_search.py new file mode 100644 index 000000000..56eeaf189 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_filter_views_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdFilterViewsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations.py new file mode 100644 index 000000000..d165db7b2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdKnowledgeRecommendations( + ApiForget, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id.py new file mode 100644 index 000000000..c43d3f430 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id.py @@ -0,0 +1,13 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id.put import ApiForput +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id.delete import ApiFordelete +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id.patch import ApiForpatch + + +class ApiV1EntitiesWorkspacesWorkspaceIdKnowledgeRecommendationsObjectId( + ApiForget, + ApiForput, + ApiFordelete, + ApiForpatch, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_search.py new file mode 100644 index 000000000..9a502eeb4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdKnowledgeRecommendationsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_labels_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_labels_search.py new file mode 100644 index 000000000..0fa5200b9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_labels_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_labels_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdLabelsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_memory_items.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_memory_items.py new file mode 100644 index 000000000..ebc335539 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_memory_items.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdMemoryItems( + ApiForget, + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id.py new file mode 100644 index 000000000..ee3abbe14 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id.py @@ -0,0 +1,13 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items_object_id.get import ApiForget +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items_object_id.put import ApiForput +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items_object_id.delete import ApiFordelete +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items_object_id.patch import ApiForpatch + + +class ApiV1EntitiesWorkspacesWorkspaceIdMemoryItemsObjectId( + ApiForget, + ApiForput, + ApiFordelete, + ApiForpatch, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_memory_items_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_memory_items_search.py new file mode 100644 index 000000000..1d7239b5d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_memory_items_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdMemoryItemsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_metrics_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_metrics_search.py new file mode 100644 index 000000000..b454a28b7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_metrics_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_metrics_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdMetricsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_search.py new file mode 100644 index 000000000..a41188909 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_user_data_filters_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdUserDataFiltersSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_search.py new file mode 100644 index 000000000..d518dd977 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_visualization_objects_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdVisualizationObjectsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_search.py new file mode 100644 index 000000000..7c840c2c8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdWorkspaceDataFilterSettingsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_search.py new file mode 100644 index 000000000..d611bd4f2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_workspace_data_filters_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdWorkspaceDataFiltersSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_search.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_search.py new file mode 100644 index 000000000..e71a98c3f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_search.py @@ -0,0 +1,7 @@ +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_workspace_settings_search.post import ApiForpost + + +class ApiV1EntitiesWorkspacesWorkspaceIdWorkspaceSettingsSearch( + ApiForpost, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_custom_geo_collections.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_custom_geo_collections.py new file mode 100644 index 000000000..c3ab6f09a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_custom_geo_collections.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_layout_custom_geo_collections.get import ApiForget +from gooddata_api_client.paths.api_v1_layout_custom_geo_collections.put import ApiForput + + +class ApiV1LayoutCustomGeoCollections( + ApiForget, + ApiForput, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_data_sources_data_source_id_permissions.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_data_sources_data_source_id_permissions.py new file mode 100644 index 000000000..036c9d131 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_data_sources_data_source_id_permissions.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_layout_data_sources_data_source_id_permissions.get import ApiForget +from gooddata_api_client.paths.api_v1_layout_data_sources_data_source_id_permissions.put import ApiForput + + +class ApiV1LayoutDataSourcesDataSourceIdPermissions( + ApiForget, + ApiForput, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_export_templates.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_export_templates.py new file mode 100644 index 000000000..bdeeb91b9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_export_templates.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_layout_export_templates.get import ApiForget +from gooddata_api_client.paths.api_v1_layout_export_templates.put import ApiForput + + +class ApiV1LayoutExportTemplates( + ApiForget, + ApiForput, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_identity_providers.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_identity_providers.py new file mode 100644 index 000000000..6474ecfc8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_identity_providers.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_layout_identity_providers.get import ApiForget +from gooddata_api_client.paths.api_v1_layout_identity_providers.put import ApiForput + + +class ApiV1LayoutIdentityProviders( + ApiForget, + ApiForput, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_notification_channels.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_notification_channels.py new file mode 100644 index 000000000..4e7ab5583 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_notification_channels.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_layout_notification_channels.get import ApiForget +from gooddata_api_client.paths.api_v1_layout_notification_channels.put import ApiForput + + +class ApiV1LayoutNotificationChannels( + ApiForget, + ApiForput, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_organization_permissions.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_organization_permissions.py new file mode 100644 index 000000000..d23486520 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_organization_permissions.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_layout_organization_permissions.get import ApiForget +from gooddata_api_client.paths.api_v1_layout_organization_permissions.put import ApiForput + + +class ApiV1LayoutOrganizationPermissions( + ApiForget, + ApiForput, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_workspaces_workspace_id_automations.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_workspaces_workspace_id_automations.py new file mode 100644 index 000000000..96cda60ff --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_workspaces_workspace_id_automations.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_layout_workspaces_workspace_id_automations.get import ApiForget +from gooddata_api_client.paths.api_v1_layout_workspaces_workspace_id_automations.put import ApiForput + + +class ApiV1LayoutWorkspacesWorkspaceIdAutomations( + ApiForget, + ApiForput, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_workspaces_workspace_id_filter_views.py b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_workspaces_workspace_id_filter_views.py new file mode 100644 index 000000000..302d03598 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/paths/api_v1_layout_workspaces_workspace_id_filter_views.py @@ -0,0 +1,9 @@ +from gooddata_api_client.paths.api_v1_layout_workspaces_workspace_id_filter_views.get import ApiForget +from gooddata_api_client.paths.api_v1_layout_workspaces_workspace_id_filter_views.put import ApiForput + + +class ApiV1LayoutWorkspacesWorkspaceIdFilterViews( + ApiForget, + ApiForput, +): + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/aac_analytics_model_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/aac_analytics_model_api.py new file mode 100644 index 000000000..2c85d6c7f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/aac_analytics_model_api.py @@ -0,0 +1,26 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_aac_workspaces_workspace_id_analytics_model.get import GetAnalyticsModelAac +from gooddata_api_client.paths.api_v1_aac_workspaces_workspace_id_analytics_model.put import SetAnalyticsModelAac + + +class AACAnalyticsModelApi( + GetAnalyticsModelAac, + SetAnalyticsModelAac, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/aac_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/aac_api.py new file mode 100644 index 000000000..5d4df8ae0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/aac_api.py @@ -0,0 +1,30 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_aac_workspaces_workspace_id_analytics_model.get import GetAnalyticsModelAac +from gooddata_api_client.paths.api_v1_aac_workspaces_workspace_id_logical_model.get import GetLogicalModelAac +from gooddata_api_client.paths.api_v1_aac_workspaces_workspace_id_analytics_model.put import SetAnalyticsModelAac +from gooddata_api_client.paths.api_v1_aac_workspaces_workspace_id_logical_model.put import SetLogicalModelAac + + +class AacApi( + GetAnalyticsModelAac, + GetLogicalModelAac, + SetAnalyticsModelAac, + SetLogicalModelAac, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/aac_logical_data_model_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/aac_logical_data_model_api.py new file mode 100644 index 000000000..dceece264 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/aac_logical_data_model_api.py @@ -0,0 +1,26 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_aac_workspaces_workspace_id_logical_model.get import GetLogicalModelAac +from gooddata_api_client.paths.api_v1_aac_workspaces_workspace_id_logical_model.put import SetLogicalModelAac + + +class AACLogicalDataModelApi( + GetLogicalModelAac, + SetLogicalModelAac, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/ai_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/ai_api.py new file mode 100644 index 000000000..bdcfeb6b1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/ai_api.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations.post import CreateEntityKnowledgeRecommendations +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items.post import CreateEntityMemoryItems +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id.delete import DeleteEntityKnowledgeRecommendations +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items_object_id.delete import DeleteEntityMemoryItems +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations.get import GetAllEntitiesKnowledgeRecommendations +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items.get import GetAllEntitiesMemoryItems +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id.get import GetEntityKnowledgeRecommendations +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items_object_id.get import GetEntityMemoryItems +from gooddata_api_client.paths.api_v1_actions_organization_metadata_check.post import MetadataCheckOrganization +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_metadata_sync.post import MetadataSync +from gooddata_api_client.paths.api_v1_actions_organization_metadata_sync.post import MetadataSyncOrganization +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id.patch import PatchEntityKnowledgeRecommendations +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items_object_id.patch import PatchEntityMemoryItems +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations_search.post import SearchEntitiesKnowledgeRecommendations +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items_search.post import SearchEntitiesMemoryItems +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id.put import UpdateEntityKnowledgeRecommendations +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items_object_id.put import UpdateEntityMemoryItems + + +class AIApi( + CreateEntityKnowledgeRecommendations, + CreateEntityMemoryItems, + DeleteEntityKnowledgeRecommendations, + DeleteEntityMemoryItems, + GetAllEntitiesKnowledgeRecommendations, + GetAllEntitiesMemoryItems, + GetEntityKnowledgeRecommendations, + GetEntityMemoryItems, + MetadataCheckOrganization, + MetadataSync, + MetadataSyncOrganization, + PatchEntityKnowledgeRecommendations, + PatchEntityMemoryItems, + SearchEntitiesKnowledgeRecommendations, + SearchEntitiesMemoryItems, + UpdateEntityKnowledgeRecommendations, + UpdateEntityMemoryItems, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/ai_lake_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/ai_lake_api.py new file mode 100644 index 000000000..72f6d2e05 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/ai_lake_api.py @@ -0,0 +1,36 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_ailake_database_instances_instance_id.delete import DeprovisionAiLakeDatabaseInstance +from gooddata_api_client.paths.api_v1_ailake_database_instances_instance_id.get import GetAiLakeDatabaseInstance +from gooddata_api_client.paths.api_v1_ailake_operations_operation_id.get import GetAiLakeOperation +from gooddata_api_client.paths.api_v1_ailake_database_instances.get import ListAiLakeDatabaseInstances +from gooddata_api_client.paths.api_v1_ailake_services.get import ListAiLakeServices +from gooddata_api_client.paths.api_v1_ailake_database_instances.post import ProvisionAiLakeDatabaseInstance +from gooddata_api_client.paths.api_v1_ailake_services_service_id_commands_command_name_run.post import RunAiLakeServiceCommand + + +class AILakeApi( + DeprovisionAiLakeDatabaseInstance, + GetAiLakeDatabaseInstance, + GetAiLakeOperation, + ListAiLakeDatabaseInstances, + ListAiLakeServices, + ProvisionAiLakeDatabaseInstance, + RunAiLakeServiceCommand, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/attribute_hierarchies_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/attribute_hierarchies_api.py new file mode 100644 index 000000000..a6266c2b3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/attribute_hierarchies_api.py @@ -0,0 +1,36 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies.post import CreateEntityAttributeHierarchies +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id.delete import DeleteEntityAttributeHierarchies +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies.get import GetAllEntitiesAttributeHierarchies +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id.get import GetEntityAttributeHierarchies +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id.patch import PatchEntityAttributeHierarchies +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies_search.post import SearchEntitiesAttributeHierarchies +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id.put import UpdateEntityAttributeHierarchies + + +class AttributeHierarchiesApi( + CreateEntityAttributeHierarchies, + DeleteEntityAttributeHierarchies, + GetAllEntitiesAttributeHierarchies, + GetEntityAttributeHierarchies, + PatchEntityAttributeHierarchies, + SearchEntitiesAttributeHierarchies, + UpdateEntityAttributeHierarchies, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/automation_organization_view_controller_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/automation_organization_view_controller_api.py new file mode 100644 index 000000000..333d684a0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/automation_organization_view_controller_api.py @@ -0,0 +1,24 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_entities_organization_workspace_automations.get import GetAllAutomationsWorkspaceAutomations + + +class AutomationOrganizationViewControllerApi( + GetAllAutomationsWorkspaceAutomations, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/automations_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/automations_api.py new file mode 100644 index 000000000..6fc4603c7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/automations_api.py @@ -0,0 +1,70 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations.post import CreateEntityAutomations +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations_object_id.delete import DeleteEntityAutomations +from gooddata_api_client.paths.api_v1_actions_organization_automations_delete.post import DeleteOrganizationAutomations +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_delete.post import DeleteWorkspaceAutomations +from gooddata_api_client.paths.api_v1_entities_organization_workspace_automations.get import GetAllAutomationsWorkspaceAutomations +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations.get import GetAllEntitiesAutomations +from gooddata_api_client.paths.api_v1_layout_workspaces_workspace_id_automations.get import GetAutomations +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations_object_id.get import GetEntityAutomations +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations_object_id.patch import PatchEntityAutomations +from gooddata_api_client.paths.api_v1_actions_organization_automations_pause.post import PauseOrganizationAutomations +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_pause.post import PauseWorkspaceAutomations +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automation_results_search.post import SearchEntitiesAutomationResults +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations_search.post import SearchEntitiesAutomations +from gooddata_api_client.paths.api_v1_layout_workspaces_workspace_id_automations.put import SetAutomations +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_trigger.post import TriggerAutomation +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_automation_id_trigger.post import TriggerExistingAutomation +from gooddata_api_client.paths.api_v1_actions_organization_automations_unpause.post import UnpauseOrganizationAutomations +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_unpause.post import UnpauseWorkspaceAutomations +from gooddata_api_client.paths.api_v1_actions_organization_automations_unsubscribe.delete import UnsubscribeAllAutomations +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_automation_id_unsubscribe.delete import UnsubscribeAutomation +from gooddata_api_client.paths.api_v1_actions_organization_automations_unsubscribe.post import UnsubscribeOrganizationAutomations +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_unsubscribe.post import UnsubscribeSelectedWorkspaceAutomations +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_unsubscribe.delete import UnsubscribeWorkspaceAutomations +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations_object_id.put import UpdateEntityAutomations + + +class AutomationsApi( + CreateEntityAutomations, + DeleteEntityAutomations, + DeleteOrganizationAutomations, + DeleteWorkspaceAutomations, + GetAllAutomationsWorkspaceAutomations, + GetAllEntitiesAutomations, + GetAutomations, + GetEntityAutomations, + PatchEntityAutomations, + PauseOrganizationAutomations, + PauseWorkspaceAutomations, + SearchEntitiesAutomationResults, + SearchEntitiesAutomations, + SetAutomations, + TriggerAutomation, + TriggerExistingAutomation, + UnpauseOrganizationAutomations, + UnpauseWorkspaceAutomations, + UnsubscribeAllAutomations, + UnsubscribeAutomation, + UnsubscribeOrganizationAutomations, + UnsubscribeSelectedWorkspaceAutomations, + UnsubscribeWorkspaceAutomations, + UpdateEntityAutomations, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/certification_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/certification_api.py new file mode 100644 index 000000000..7813c833c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/certification_api.py @@ -0,0 +1,24 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_set_certification.post import SetCertification + + +class CertificationApi( + SetCertification, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/export_definitions_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/export_definitions_api.py new file mode 100644 index 000000000..04fab9b2f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/export_definitions_api.py @@ -0,0 +1,36 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions.post import CreateEntityExportDefinitions +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions_object_id.delete import DeleteEntityExportDefinitions +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions.get import GetAllEntitiesExportDefinitions +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions_object_id.get import GetEntityExportDefinitions +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions_object_id.patch import PatchEntityExportDefinitions +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions_search.post import SearchEntitiesExportDefinitions +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions_object_id.put import UpdateEntityExportDefinitions + + +class ExportDefinitionsApi( + CreateEntityExportDefinitions, + DeleteEntityExportDefinitions, + GetAllEntitiesExportDefinitions, + GetEntityExportDefinitions, + PatchEntityExportDefinitions, + SearchEntitiesExportDefinitions, + UpdateEntityExportDefinitions, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/export_templates_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/export_templates_api.py new file mode 100644 index 000000000..29fe74604 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/export_templates_api.py @@ -0,0 +1,34 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_entities_export_templates.post import CreateEntityExportTemplates +from gooddata_api_client.paths.api_v1_entities_export_templates_id.delete import DeleteEntityExportTemplates +from gooddata_api_client.paths.api_v1_entities_export_templates.get import GetAllEntitiesExportTemplates +from gooddata_api_client.paths.api_v1_entities_export_templates_id.get import GetEntityExportTemplates +from gooddata_api_client.paths.api_v1_entities_export_templates_id.patch import PatchEntityExportTemplates +from gooddata_api_client.paths.api_v1_entities_export_templates_id.put import UpdateEntityExportTemplates + + +class ExportTemplatesApi( + CreateEntityExportTemplates, + DeleteEntityExportTemplates, + GetAllEntitiesExportTemplates, + GetEntityExportTemplates, + PatchEntityExportTemplates, + UpdateEntityExportTemplates, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/filter_context_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/filter_context_api.py new file mode 100644 index 000000000..64391fbb5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/filter_context_api.py @@ -0,0 +1,36 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_contexts.post import CreateEntityFilterContexts +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_contexts_object_id.delete import DeleteEntityFilterContexts +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_contexts.get import GetAllEntitiesFilterContexts +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_contexts_object_id.get import GetEntityFilterContexts +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_contexts_object_id.patch import PatchEntityFilterContexts +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_contexts_search.post import SearchEntitiesFilterContexts +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_contexts_object_id.put import UpdateEntityFilterContexts + + +class FilterContextApi( + CreateEntityFilterContexts, + DeleteEntityFilterContexts, + GetAllEntitiesFilterContexts, + GetEntityFilterContexts, + PatchEntityFilterContexts, + SearchEntitiesFilterContexts, + UpdateEntityFilterContexts, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/filter_views_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/filter_views_api.py new file mode 100644 index 000000000..dba9e5af9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/filter_views_api.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views.post import CreateEntityFilterViews +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views_object_id.delete import DeleteEntityFilterViews +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views.get import GetAllEntitiesFilterViews +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views_object_id.get import GetEntityFilterViews +from gooddata_api_client.paths.api_v1_layout_workspaces_workspace_id_filter_views.get import GetFilterViews +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views_object_id.patch import PatchEntityFilterViews +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views_search.post import SearchEntitiesFilterViews +from gooddata_api_client.paths.api_v1_layout_workspaces_workspace_id_filter_views.put import SetFilterViews +from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views_object_id.put import UpdateEntityFilterViews + + +class FilterViewsApi( + CreateEntityFilterViews, + DeleteEntityFilterViews, + GetAllEntitiesFilterViews, + GetEntityFilterViews, + GetFilterViews, + PatchEntityFilterViews, + SearchEntitiesFilterViews, + SetFilterViews, + UpdateEntityFilterViews, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/geographic_data_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/geographic_data_api.py new file mode 100644 index 000000000..b81bfea1e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/geographic_data_api.py @@ -0,0 +1,34 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_entities_custom_geo_collections.post import CreateEntityCustomGeoCollections +from gooddata_api_client.paths.api_v1_entities_custom_geo_collections_id.delete import DeleteEntityCustomGeoCollections +from gooddata_api_client.paths.api_v1_entities_custom_geo_collections.get import GetAllEntitiesCustomGeoCollections +from gooddata_api_client.paths.api_v1_entities_custom_geo_collections_id.get import GetEntityCustomGeoCollections +from gooddata_api_client.paths.api_v1_entities_custom_geo_collections_id.patch import PatchEntityCustomGeoCollections +from gooddata_api_client.paths.api_v1_entities_custom_geo_collections_id.put import UpdateEntityCustomGeoCollections + + +class GeographicDataApi( + CreateEntityCustomGeoCollections, + DeleteEntityCustomGeoCollections, + GetAllEntitiesCustomGeoCollections, + GetEntityCustomGeoCollections, + PatchEntityCustomGeoCollections, + UpdateEntityCustomGeoCollections, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/hierarchy_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/hierarchy_api.py new file mode 100644 index 000000000..3c7f9e190 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/hierarchy_api.py @@ -0,0 +1,30 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_check_entity_overrides.post import CheckEntityOverrides +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_inherited_entity_conflicts.get import InheritedEntityConflicts +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_inherited_entity_prefixes.get import InheritedEntityPrefixes +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_overridden_child_entities.get import OverriddenChildEntities + + +class HierarchyApi( + CheckEntityOverrides, + InheritedEntityConflicts, + InheritedEntityPrefixes, + OverriddenChildEntities, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/identity_providers_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/identity_providers_api.py new file mode 100644 index 000000000..3533d022b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/identity_providers_api.py @@ -0,0 +1,38 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_entities_identity_providers.post import CreateEntityIdentityProviders +from gooddata_api_client.paths.api_v1_entities_identity_providers_id.delete import DeleteEntityIdentityProviders +from gooddata_api_client.paths.api_v1_entities_identity_providers.get import GetAllEntitiesIdentityProviders +from gooddata_api_client.paths.api_v1_entities_identity_providers_id.get import GetEntityIdentityProviders +from gooddata_api_client.paths.api_v1_layout_identity_providers.get import GetIdentityProvidersLayout +from gooddata_api_client.paths.api_v1_entities_identity_providers_id.patch import PatchEntityIdentityProviders +from gooddata_api_client.paths.api_v1_layout_identity_providers.put import SetIdentityProviders +from gooddata_api_client.paths.api_v1_entities_identity_providers_id.put import UpdateEntityIdentityProviders + + +class IdentityProvidersApi( + CreateEntityIdentityProviders, + DeleteEntityIdentityProviders, + GetAllEntitiesIdentityProviders, + GetEntityIdentityProviders, + GetIdentityProvidersLayout, + PatchEntityIdentityProviders, + SetIdentityProviders, + UpdateEntityIdentityProviders, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/image_export_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/image_export_api.py new file mode 100644 index 000000000..f7b93795d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/image_export_api.py @@ -0,0 +1,28 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_image.post import CreateImageExport +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_image_export_id.get import GetImageExport +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_image_export_id_metadata.get import GetImageExportMetadata + + +class ImageExportApi( + CreateImageExport, + GetImageExport, + GetImageExportMetadata, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/jwks_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/jwks_api.py new file mode 100644 index 000000000..98e51d302 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/jwks_api.py @@ -0,0 +1,34 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_entities_jwks.post import CreateEntityJwks +from gooddata_api_client.paths.api_v1_entities_jwks_id.delete import DeleteEntityJwks +from gooddata_api_client.paths.api_v1_entities_jwks.get import GetAllEntitiesJwks +from gooddata_api_client.paths.api_v1_entities_jwks_id.get import GetEntityJwks +from gooddata_api_client.paths.api_v1_entities_jwks_id.patch import PatchEntityJwks +from gooddata_api_client.paths.api_v1_entities_jwks_id.put import UpdateEntityJwks + + +class JWKSApi( + CreateEntityJwks, + DeleteEntityJwks, + GetAllEntitiesJwks, + GetEntityJwks, + PatchEntityJwks, + UpdateEntityJwks, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/llm_endpoints_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/llm_endpoints_api.py new file mode 100644 index 000000000..fc4d158c9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/llm_endpoints_api.py @@ -0,0 +1,34 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_entities_llm_endpoints.post import CreateEntityLlmEndpoints +from gooddata_api_client.paths.api_v1_entities_llm_endpoints_id.delete import DeleteEntityLlmEndpoints +from gooddata_api_client.paths.api_v1_entities_llm_endpoints.get import GetAllEntitiesLlmEndpoints +from gooddata_api_client.paths.api_v1_entities_llm_endpoints_id.get import GetEntityLlmEndpoints +from gooddata_api_client.paths.api_v1_entities_llm_endpoints_id.patch import PatchEntityLlmEndpoints +from gooddata_api_client.paths.api_v1_entities_llm_endpoints_id.put import UpdateEntityLlmEndpoints + + +class LLMEndpointsApi( + CreateEntityLlmEndpoints, + DeleteEntityLlmEndpoints, + GetAllEntitiesLlmEndpoints, + GetEntityLlmEndpoints, + PatchEntityLlmEndpoints, + UpdateEntityLlmEndpoints, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/llm_providers_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/llm_providers_api.py new file mode 100644 index 000000000..60a61756a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/llm_providers_api.py @@ -0,0 +1,34 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_entities_llm_providers.post import CreateEntityLlmProviders +from gooddata_api_client.paths.api_v1_entities_llm_providers_id.delete import DeleteEntityLlmProviders +from gooddata_api_client.paths.api_v1_entities_llm_providers.get import GetAllEntitiesLlmProviders +from gooddata_api_client.paths.api_v1_entities_llm_providers_id.get import GetEntityLlmProviders +from gooddata_api_client.paths.api_v1_entities_llm_providers_id.patch import PatchEntityLlmProviders +from gooddata_api_client.paths.api_v1_entities_llm_providers_id.put import UpdateEntityLlmProviders + + +class LLMProvidersApi( + CreateEntityLlmProviders, + DeleteEntityLlmProviders, + GetAllEntitiesLlmProviders, + GetEntityLlmProviders, + PatchEntityLlmProviders, + UpdateEntityLlmProviders, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/manage_permissions_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/manage_permissions_api.py new file mode 100644 index 000000000..5c213b94e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/manage_permissions_api.py @@ -0,0 +1,28 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_layout_data_sources_data_source_id_permissions.get import GetDataSourcePermissions +from gooddata_api_client.paths.api_v1_actions_data_sources_data_source_id_manage_permissions.post import ManageDataSourcePermissions +from gooddata_api_client.paths.api_v1_layout_data_sources_data_source_id_permissions.put import SetDataSourcePermissions + + +class ManagePermissionsApi( + GetDataSourcePermissions, + ManageDataSourcePermissions, + SetDataSourcePermissions, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/metadata_check_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/metadata_check_api.py new file mode 100644 index 000000000..a78e84dfe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/metadata_check_api.py @@ -0,0 +1,24 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_actions_organization_metadata_check.post import MetadataCheckOrganization + + +class MetadataCheckApi( + MetadataCheckOrganization, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/metadata_sync_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/metadata_sync_api.py new file mode 100644 index 000000000..c3bf00652 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/metadata_sync_api.py @@ -0,0 +1,26 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_metadata_sync.post import MetadataSync +from gooddata_api_client.paths.api_v1_actions_organization_metadata_sync.post import MetadataSyncOrganization + + +class MetadataSyncApi( + MetadataSync, + MetadataSyncOrganization, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/notification_channels_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/notification_channels_api.py new file mode 100644 index 000000000..802196f46 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/notification_channels_api.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_entities_notification_channels.post import CreateEntityNotificationChannels +from gooddata_api_client.paths.api_v1_entities_notification_channels_id.delete import DeleteEntityNotificationChannels +from gooddata_api_client.paths.api_v1_entities_notification_channel_identifiers.get import GetAllEntitiesNotificationChannelIdentifiers +from gooddata_api_client.paths.api_v1_entities_notification_channels.get import GetAllEntitiesNotificationChannels +from gooddata_api_client.paths.api_v1_entities_notification_channel_identifiers_id.get import GetEntityNotificationChannelIdentifiers +from gooddata_api_client.paths.api_v1_entities_notification_channels_id.get import GetEntityNotificationChannels +from gooddata_api_client.paths.api_v1_layout_export_templates.get import GetExportTemplatesLayout +from gooddata_api_client.paths.api_v1_layout_notification_channels.get import GetNotificationChannelsLayout +from gooddata_api_client.paths.api_v1_actions_notifications.get import GetNotifications +from gooddata_api_client.paths.api_v1_actions_notifications_notification_id_mark_as_read.post import MarkAsReadNotification +from gooddata_api_client.paths.api_v1_actions_notifications_mark_as_read.post import MarkAsReadNotificationAll +from gooddata_api_client.paths.api_v1_entities_notification_channels_id.patch import PatchEntityNotificationChannels +from gooddata_api_client.paths.api_v1_layout_export_templates.put import SetExportTemplates +from gooddata_api_client.paths.api_v1_layout_notification_channels.put import SetNotificationChannels +from gooddata_api_client.paths.api_v1_actions_notification_channels_notification_channel_id_test.post import TestExistingNotificationChannel +from gooddata_api_client.paths.api_v1_actions_notification_channels_test.post import TestNotificationChannel +from gooddata_api_client.paths.api_v1_entities_notification_channels_id.put import UpdateEntityNotificationChannels + + +class NotificationChannelsApi( + CreateEntityNotificationChannels, + DeleteEntityNotificationChannels, + GetAllEntitiesNotificationChannelIdentifiers, + GetAllEntitiesNotificationChannels, + GetEntityNotificationChannelIdentifiers, + GetEntityNotificationChannels, + GetExportTemplatesLayout, + GetNotificationChannelsLayout, + GetNotifications, + MarkAsReadNotification, + MarkAsReadNotificationAll, + PatchEntityNotificationChannels, + SetExportTemplates, + SetNotificationChannels, + TestExistingNotificationChannel, + TestNotificationChannel, + UpdateEntityNotificationChannels, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/organization_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/organization_api.py new file mode 100644 index 000000000..6f4269622 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/organization_api.py @@ -0,0 +1,24 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_actions_organization_switch_active_identity_provider.post import SwitchActiveIdentityProvider + + +class OrganizationApi( + SwitchActiveIdentityProvider, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/raw_export_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/raw_export_api.py new file mode 100644 index 000000000..5bcc9789b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/raw_export_api.py @@ -0,0 +1,26 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_raw.post import CreateRawExport +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_raw_export_id.get import GetRawExport + + +class RawExportApi( + CreateRawExport, + GetRawExport, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/slides_export_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/slides_export_api.py new file mode 100644 index 000000000..f7a080f28 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/slides_export_api.py @@ -0,0 +1,28 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_slides.post import CreateSlidesExport +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_slides_export_id.get import GetSlidesExport +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_slides_export_id_metadata.get import GetSlidesExportMetadata + + +class SlidesExportApi( + CreateSlidesExport, + GetSlidesExport, + GetSlidesExportMetadata, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/smart_functions_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/smart_functions_api.py new file mode 100644 index 000000000..0b31b0eba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/smart_functions_api.py @@ -0,0 +1,70 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_chat.post import AiChat +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_chat_history.post import AiChatHistory +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_chat_stream.post import AiChatStream +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_chat_usage.get import AiChatUsage +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_search.post import AiSearch +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_id.post import AnomalyDetection +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_result_id.get import AnomalyDetectionResult +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_id.post import Clustering +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_result_id.get import ClusteringResult +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_created_by.get import CreatedBy +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_id.post import Forecast +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_result_id.get import ForecastResult +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_description.post import GenerateDescription +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_title.post import GenerateTitle +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_issues.get import GetQualityIssues +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_issues_status_process_id.get import GetQualityIssuesCalculationStatus +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_memory_created_by.get import MemoryCreatedByUsers +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_resolve_llm_endpoints.get import ResolveLlmEndpoints +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_tags.get import Tags +from gooddata_api_client.paths.api_v1_actions_ai_llm_provider_test.post import TestLlmProvider +from gooddata_api_client.paths.api_v1_actions_ai_llm_provider_llm_provider_id_test.post import TestLlmProviderById +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_issues_trigger_check.post import TriggerQualityIssuesCalculation +from gooddata_api_client.paths.api_v1_actions_ai_llm_endpoint_test.post import ValidateLlmEndpoint +from gooddata_api_client.paths.api_v1_actions_ai_llm_endpoint_llm_endpoint_id_test.post import ValidateLlmEndpointById + + +class SmartFunctionsApi( + AiChat, + AiChatHistory, + AiChatStream, + AiChatUsage, + AiSearch, + AnomalyDetection, + AnomalyDetectionResult, + Clustering, + ClusteringResult, + CreatedBy, + Forecast, + ForecastResult, + GenerateDescription, + GenerateTitle, + GetQualityIssues, + GetQualityIssuesCalculationStatus, + MemoryCreatedByUsers, + ResolveLlmEndpoints, + Tags, + TestLlmProvider, + TestLlmProviderById, + TriggerQualityIssuesCalculation, + ValidateLlmEndpoint, + ValidateLlmEndpointById, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/tabular_export_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/tabular_export_api.py new file mode 100644 index 000000000..3943a9e01 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/tabular_export_api.py @@ -0,0 +1,28 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_export_tabular.post import CreateDashboardExportRequest +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_tabular.post import CreateTabularExport +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_tabular_export_id.get import GetTabularExport + + +class TabularExportApi( + CreateDashboardExportRequest, + CreateTabularExport, + GetTabularExport, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/translations_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/translations_api.py new file mode 100644 index 000000000..3ce9d79c8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/translations_api.py @@ -0,0 +1,30 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_translations_clean.post import CleanTranslations +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_translations.get import GetTranslationTags +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_translations_retrieve.post import RetrieveTranslations +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_translations_set.post import SetTranslations + + +class TranslationsApi( + CleanTranslations, + GetTranslationTags, + RetrieveTranslations, + SetTranslations, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/user_identifiers_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/user_identifiers_api.py new file mode 100644 index 000000000..b6924309e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/user_identifiers_api.py @@ -0,0 +1,26 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_entities_user_identifiers.get import GetAllEntitiesUserIdentifiers +from gooddata_api_client.paths.api_v1_entities_user_identifiers_id.get import GetEntityUserIdentifiers + + +class UserIdentifiersApi( + GetAllEntitiesUserIdentifiers, + GetEntityUserIdentifiers, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/user_management_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/user_management_api.py new file mode 100644 index 000000000..f2578127c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/user_management_api.py @@ -0,0 +1,50 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_actions_user_management_user_groups_user_group_id_add_members.post import AddGroupMembers +from gooddata_api_client.paths.api_v1_actions_user_management_assign_permissions.post import AssignPermissions +from gooddata_api_client.paths.api_v1_actions_user_management_user_groups_user_group_id_members.get import GetGroupMembers +from gooddata_api_client.paths.api_v1_actions_user_management_users_user_id_permissions.get import ListPermissionsForUser +from gooddata_api_client.paths.api_v1_actions_user_management_user_groups_user_group_id_permissions.get import ListPermissionsForUserGroup +from gooddata_api_client.paths.api_v1_actions_user_management_user_groups.get import ListUserGroups +from gooddata_api_client.paths.api_v1_actions_user_management_users.get import ListUsers +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_user_groups.get import ListWorkspaceUserGroups +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_users.get import ListWorkspaceUsers +from gooddata_api_client.paths.api_v1_actions_user_management_users_user_id_permissions.post import ManagePermissionsForUser +from gooddata_api_client.paths.api_v1_actions_user_management_user_groups_user_group_id_permissions.post import ManagePermissionsForUserGroup +from gooddata_api_client.paths.api_v1_actions_user_management_user_groups_user_group_id_remove_members.post import RemoveGroupMembers +from gooddata_api_client.paths.api_v1_actions_user_management_remove_users_user_groups.post import RemoveUsersUserGroups +from gooddata_api_client.paths.api_v1_actions_user_management_revoke_permissions.post import RevokePermissions + + +class UserManagementApi( + AddGroupMembers, + AssignPermissions, + GetGroupMembers, + ListPermissionsForUser, + ListPermissionsForUserGroup, + ListUserGroups, + ListUsers, + ListWorkspaceUserGroups, + ListWorkspaceUsers, + ManagePermissionsForUser, + ManagePermissionsForUserGroup, + RemoveGroupMembers, + RemoveUsersUserGroups, + RevokePermissions, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/apis/tags/visual_export_api.py b/gooddata-api-client/gooddata_api_client/apis/tags/visual_export_api.py new file mode 100644 index 000000000..c8b6c481d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/apis/tags/visual_export_api.py @@ -0,0 +1,28 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_visual.post import CreatePdfExport +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_visual_export_id.get import GetExportedFile +from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_visual_export_id_metadata.get import GetMetadata + + +class VisualExportApi( + CreatePdfExport, + GetExportedFile, + GetMetadata, +): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + pass diff --git a/gooddata-api-client/gooddata_api_client/model/aac_analytics_model.pyi b/gooddata-api-client/gooddata_api_client/model/aac_analytics_model.pyi new file mode 100644 index 000000000..eb9535c15 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_analytics_model.pyi @@ -0,0 +1,252 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacAnalyticsModel( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + AAC analytics model representation compatible with Analytics-as-Code YAML format. + """ + + + class MetaOapg: + + class properties: + + + class attribute_hierarchies( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacAttributeHierarchy']: + return AacAttributeHierarchy + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacAttributeHierarchy'], typing.List['AacAttributeHierarchy']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attribute_hierarchies': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacAttributeHierarchy': + return super().__getitem__(i) + + + class dashboards( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacDashboard']: + return AacDashboard + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacDashboard'], typing.List['AacDashboard']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dashboards': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacDashboard': + return super().__getitem__(i) + + + class metrics( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacMetric']: + return AacMetric + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacMetric'], typing.List['AacMetric']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'metrics': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacMetric': + return super().__getitem__(i) + + + class plugins( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacPlugin']: + return AacPlugin + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacPlugin'], typing.List['AacPlugin']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'plugins': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacPlugin': + return super().__getitem__(i) + + + class visualizations( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacVisualization']: + return AacVisualization + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacVisualization'], typing.List['AacVisualization']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visualizations': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacVisualization': + return super().__getitem__(i) + __annotations__ = { + "attribute_hierarchies": attribute_hierarchies, + "dashboards": dashboards, + "metrics": metrics, + "plugins": plugins, + "visualizations": visualizations, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attribute_hierarchies"]) -> MetaOapg.properties.attribute_hierarchies: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboards"]) -> MetaOapg.properties.dashboards: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["plugins"]) -> MetaOapg.properties.plugins: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualizations"]) -> MetaOapg.properties.visualizations: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attribute_hierarchies", "dashboards", "metrics", "plugins", "visualizations", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attribute_hierarchies"]) -> typing.Union[MetaOapg.properties.attribute_hierarchies, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboards"]) -> typing.Union[MetaOapg.properties.dashboards, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["plugins"]) -> typing.Union[MetaOapg.properties.plugins, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualizations"]) -> typing.Union[MetaOapg.properties.visualizations, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attribute_hierarchies", "dashboards", "metrics", "plugins", "visualizations", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attribute_hierarchies: typing.Union[MetaOapg.properties.attribute_hierarchies, list, tuple, schemas.Unset] = schemas.unset, + dashboards: typing.Union[MetaOapg.properties.dashboards, list, tuple, schemas.Unset] = schemas.unset, + metrics: typing.Union[MetaOapg.properties.metrics, list, tuple, schemas.Unset] = schemas.unset, + plugins: typing.Union[MetaOapg.properties.plugins, list, tuple, schemas.Unset] = schemas.unset, + visualizations: typing.Union[MetaOapg.properties.visualizations, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacAnalyticsModel': + return super().__new__( + cls, + *_args, + attribute_hierarchies=attribute_hierarchies, + dashboards=dashboards, + metrics=metrics, + plugins=plugins, + visualizations=visualizations, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_attribute_hierarchy import AacAttributeHierarchy +from gooddata_api_client.model.aac_dashboard import AacDashboard +from gooddata_api_client.model.aac_metric import AacMetric +from gooddata_api_client.model.aac_plugin import AacPlugin +from gooddata_api_client.model.aac_visualization import AacVisualization diff --git a/gooddata-api-client/gooddata_api_client/model/aac_attribute_hierarchy.pyi b/gooddata-api-client/gooddata_api_client/model/aac_attribute_hierarchy.pyi new file mode 100644 index 000000000..95453ab3c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_attribute_hierarchy.pyi @@ -0,0 +1,184 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacAttributeHierarchy( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + AAC attribute hierarchy definition. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attributes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + id = schemas.StrSchema + type = schemas.StrSchema + description = schemas.StrSchema + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + "description": description, + "tags": tags, + "title": title, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "description", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "description", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, list, tuple, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacAttributeHierarchy': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + description=description, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/aac_container_widget.pyi b/gooddata-api-client/gooddata_api_client/model/aac_container_widget.pyi new file mode 100644 index 000000000..c3f80fc23 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_container_widget.pyi @@ -0,0 +1,715 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacContainerWidget( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "sections", + } + + class properties: + + + class sections( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacSection']: + return AacSection + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacSection'], typing.List['AacSection']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'sections': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacSection': + return super().__getitem__(i) + + + class additionalProperties( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['JsonNode']: + return JsonNode + + def __getitem__(self, name: typing.Union[str, ]) -> 'JsonNode': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'JsonNode': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'JsonNode', + ) -> 'additionalProperties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + columns = schemas.Int32Schema + container = schemas.StrSchema + content = schemas.StrSchema + date = schemas.StrSchema + + + class description( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + + + class one_of_1( + schemas.EnumBase, + schemas.BoolSchema + ): + + @schemas.classproperty + def FALSE(cls): + return cls(False) + + + class one_of_2( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INHERIT(cls): + return cls("inherit") + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'description': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @staticmethod + def drill_down() -> typing.Type['JsonNode']: + return JsonNode + enable_section_headers = schemas.BoolSchema + + + class ignore_dashboard_filters( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ignore_dashboard_filters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class ignored_filters( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ignored_filters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class interactions( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonNode']: + return JsonNode + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonNode'], typing.List['JsonNode']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'interactions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonNode': + return super().__getitem__(i) + layout_direction = schemas.StrSchema + metric = schemas.StrSchema + rows = schemas.Int32Schema + + @staticmethod + def size() -> typing.Type['AacWidgetSize']: + return AacWidgetSize + + + class title( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + + + class one_of_1( + schemas.EnumBase, + schemas.BoolSchema + ): + + @schemas.classproperty + def FALSE(cls): + return cls(False) + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'title': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + type = schemas.StrSchema + visualization = schemas.StrSchema + + + class visualizations( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacWidget']: + return AacWidget + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacWidget'], typing.List['AacWidget']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visualizations': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacWidget': + return super().__getitem__(i) + zoom_data = schemas.BoolSchema + __annotations__ = { + "sections": sections, + "additionalProperties": additionalProperties, + "columns": columns, + "container": container, + "content": content, + "date": date, + "description": description, + "drill_down": drill_down, + "enable_section_headers": enable_section_headers, + "ignore_dashboard_filters": ignore_dashboard_filters, + "ignored_filters": ignored_filters, + "interactions": interactions, + "layout_direction": layout_direction, + "metric": metric, + "rows": rows, + "size": size, + "title": title, + "type": type, + "visualization": visualization, + "visualizations": visualizations, + "zoom_data": zoom_data, + } + + + class all_of_0( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "visualization", + } + + + visualization: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_1( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "content", + } + + + content: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_2( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "visualizations", + } + + + visualizations: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_2': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + cls.all_of_1, + cls.all_of_2, + ] + + + sections: MetaOapg.properties.sections + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sections"]) -> MetaOapg.properties.sections: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["additionalProperties"]) -> MetaOapg.properties.additionalProperties: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["container"]) -> MetaOapg.properties.container: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["date"]) -> MetaOapg.properties.date: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["drill_down"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["enable_section_headers"]) -> MetaOapg.properties.enable_section_headers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["ignore_dashboard_filters"]) -> MetaOapg.properties.ignore_dashboard_filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["ignored_filters"]) -> MetaOapg.properties.ignored_filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["interactions"]) -> MetaOapg.properties.interactions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["layout_direction"]) -> MetaOapg.properties.layout_direction: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metric"]) -> MetaOapg.properties.metric: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rows"]) -> MetaOapg.properties.rows: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["size"]) -> 'AacWidgetSize': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualization"]) -> MetaOapg.properties.visualization: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualizations"]) -> MetaOapg.properties.visualizations: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["zoom_data"]) -> MetaOapg.properties.zoom_data: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["sections", "additionalProperties", "columns", "container", "content", "date", "description", "drill_down", "enable_section_headers", "ignore_dashboard_filters", "ignored_filters", "interactions", "layout_direction", "metric", "rows", "size", "title", "type", "visualization", "visualizations", "zoom_data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sections"]) -> MetaOapg.properties.sections: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["additionalProperties"]) -> typing.Union[MetaOapg.properties.additionalProperties, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> typing.Union[MetaOapg.properties.columns, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["container"]) -> typing.Union[MetaOapg.properties.container, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union[MetaOapg.properties.content, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["date"]) -> typing.Union[MetaOapg.properties.date, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["drill_down"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["enable_section_headers"]) -> typing.Union[MetaOapg.properties.enable_section_headers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["ignore_dashboard_filters"]) -> typing.Union[MetaOapg.properties.ignore_dashboard_filters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["ignored_filters"]) -> typing.Union[MetaOapg.properties.ignored_filters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["interactions"]) -> typing.Union[MetaOapg.properties.interactions, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["layout_direction"]) -> typing.Union[MetaOapg.properties.layout_direction, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metric"]) -> typing.Union[MetaOapg.properties.metric, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rows"]) -> typing.Union[MetaOapg.properties.rows, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["size"]) -> typing.Union['AacWidgetSize', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> typing.Union[MetaOapg.properties.type, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualization"]) -> typing.Union[MetaOapg.properties.visualization, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualizations"]) -> typing.Union[MetaOapg.properties.visualizations, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["zoom_data"]) -> typing.Union[MetaOapg.properties.zoom_data, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["sections", "additionalProperties", "columns", "container", "content", "date", "description", "drill_down", "enable_section_headers", "ignore_dashboard_filters", "ignored_filters", "interactions", "layout_direction", "metric", "rows", "size", "title", "type", "visualization", "visualizations", "zoom_data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + sections: typing.Union[MetaOapg.properties.sections, list, tuple, ], + additionalProperties: typing.Union[MetaOapg.properties.additionalProperties, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + columns: typing.Union[MetaOapg.properties.columns, decimal.Decimal, int, schemas.Unset] = schemas.unset, + container: typing.Union[MetaOapg.properties.container, str, schemas.Unset] = schemas.unset, + content: typing.Union[MetaOapg.properties.content, str, schemas.Unset] = schemas.unset, + date: typing.Union[MetaOapg.properties.date, str, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + drill_down: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + enable_section_headers: typing.Union[MetaOapg.properties.enable_section_headers, bool, schemas.Unset] = schemas.unset, + ignore_dashboard_filters: typing.Union[MetaOapg.properties.ignore_dashboard_filters, list, tuple, schemas.Unset] = schemas.unset, + ignored_filters: typing.Union[MetaOapg.properties.ignored_filters, list, tuple, schemas.Unset] = schemas.unset, + interactions: typing.Union[MetaOapg.properties.interactions, list, tuple, schemas.Unset] = schemas.unset, + layout_direction: typing.Union[MetaOapg.properties.layout_direction, str, schemas.Unset] = schemas.unset, + metric: typing.Union[MetaOapg.properties.metric, str, schemas.Unset] = schemas.unset, + rows: typing.Union[MetaOapg.properties.rows, decimal.Decimal, int, schemas.Unset] = schemas.unset, + size: typing.Union['AacWidgetSize', schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + type: typing.Union[MetaOapg.properties.type, str, schemas.Unset] = schemas.unset, + visualization: typing.Union[MetaOapg.properties.visualization, str, schemas.Unset] = schemas.unset, + visualizations: typing.Union[MetaOapg.properties.visualizations, list, tuple, schemas.Unset] = schemas.unset, + zoom_data: typing.Union[MetaOapg.properties.zoom_data, bool, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacContainerWidget': + return super().__new__( + cls, + *_args, + sections=sections, + additionalProperties=additionalProperties, + columns=columns, + container=container, + content=content, + date=date, + description=description, + drill_down=drill_down, + enable_section_headers=enable_section_headers, + ignore_dashboard_filters=ignore_dashboard_filters, + ignored_filters=ignored_filters, + interactions=interactions, + layout_direction=layout_direction, + metric=metric, + rows=rows, + size=size, + title=title, + type=type, + visualization=visualization, + visualizations=visualizations, + zoom_data=zoom_data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_section import AacSection +from gooddata_api_client.model.aac_widget import AacWidget +from gooddata_api_client.model.aac_widget_size import AacWidgetSize +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_dashboard.pyi b/gooddata-api-client/gooddata_api_client/model/aac_dashboard.pyi new file mode 100644 index 000000000..7e3132e9d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_dashboard.pyi @@ -0,0 +1,71 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacDashboard( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + AAC dashboard definition. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AacDashboardWithTabs, + AacDashboardWithoutTabs, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacDashboard': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_dashboard_with_tabs import AacDashboardWithTabs +from gooddata_api_client.model.aac_dashboard_without_tabs import AacDashboardWithoutTabs diff --git a/gooddata-api-client/gooddata_api_client/model/aac_dashboard_filter.pyi b/gooddata-api-client/gooddata_api_client/model/aac_dashboard_filter.pyi new file mode 100644 index 000000000..1fe05d4ad --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_dashboard_filter.pyi @@ -0,0 +1,333 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacDashboardFilter( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Tab-specific filters. + """ + + + class MetaOapg: + required = { + "type", + } + + class properties: + type = schemas.StrSchema + date = schemas.StrSchema + display_as = schemas.StrSchema + + + class _from( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.Int32Schema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> '_from': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + granularity = schemas.StrSchema + + + class metric_filters( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'metric_filters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + mode = schemas.StrSchema + multiselect = schemas.BoolSchema + + + class parents( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonNode']: + return JsonNode + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonNode'], typing.List['JsonNode']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'parents': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonNode': + return super().__getitem__(i) + + @staticmethod + def state() -> typing.Type['AacFilterState']: + return AacFilterState + title = schemas.StrSchema + + + class to( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.Int32Schema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'to': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + using = schemas.StrSchema + __annotations__ = { + "type": type, + "date": date, + "display_as": display_as, + "from": _from, + "granularity": granularity, + "metric_filters": metric_filters, + "mode": mode, + "multiselect": multiselect, + "parents": parents, + "state": state, + "title": title, + "to": to, + "using": using, + } + + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["date"]) -> MetaOapg.properties.date: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["display_as"]) -> MetaOapg.properties.display_as: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metric_filters"]) -> MetaOapg.properties.metric_filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["mode"]) -> MetaOapg.properties.mode: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["multiselect"]) -> MetaOapg.properties.multiselect: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["parents"]) -> MetaOapg.properties.parents: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["state"]) -> 'AacFilterState': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> MetaOapg.properties.to: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["using"]) -> MetaOapg.properties.using: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["type", "date", "display_as", "from", "granularity", "metric_filters", "mode", "multiselect", "parents", "state", "title", "to", "using", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["date"]) -> typing.Union[MetaOapg.properties.date, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["display_as"]) -> typing.Union[MetaOapg.properties.display_as, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> typing.Union[MetaOapg.properties._from, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["granularity"]) -> typing.Union[MetaOapg.properties.granularity, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metric_filters"]) -> typing.Union[MetaOapg.properties.metric_filters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["mode"]) -> typing.Union[MetaOapg.properties.mode, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["multiselect"]) -> typing.Union[MetaOapg.properties.multiselect, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["parents"]) -> typing.Union[MetaOapg.properties.parents, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["state"]) -> typing.Union['AacFilterState', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> typing.Union[MetaOapg.properties.to, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["using"]) -> typing.Union[MetaOapg.properties.using, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["type", "date", "display_as", "from", "granularity", "metric_filters", "mode", "multiselect", "parents", "state", "title", "to", "using", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + date: typing.Union[MetaOapg.properties.date, str, schemas.Unset] = schemas.unset, + display_as: typing.Union[MetaOapg.properties.display_as, str, schemas.Unset] = schemas.unset, + granularity: typing.Union[MetaOapg.properties.granularity, str, schemas.Unset] = schemas.unset, + metric_filters: typing.Union[MetaOapg.properties.metric_filters, list, tuple, schemas.Unset] = schemas.unset, + mode: typing.Union[MetaOapg.properties.mode, str, schemas.Unset] = schemas.unset, + multiselect: typing.Union[MetaOapg.properties.multiselect, bool, schemas.Unset] = schemas.unset, + parents: typing.Union[MetaOapg.properties.parents, list, tuple, schemas.Unset] = schemas.unset, + state: typing.Union['AacFilterState', schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + to: typing.Union[MetaOapg.properties.to, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + using: typing.Union[MetaOapg.properties.using, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacDashboardFilter': + return super().__new__( + cls, + *_args, + type=type, + date=date, + display_as=display_as, + granularity=granularity, + metric_filters=metric_filters, + mode=mode, + multiselect=multiselect, + parents=parents, + state=state, + title=title, + to=to, + using=using, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_filter_state import AacFilterState +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_dashboard_permissions.pyi b/gooddata-api-client/gooddata_api_client/model/aac_dashboard_permissions.pyi new file mode 100644 index 000000000..3e042e3ee --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_dashboard_permissions.pyi @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacDashboardPermissions( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Dashboard permissions. + """ + + + class MetaOapg: + + class properties: + + @staticmethod + def edit() -> typing.Type['AacPermission']: + return AacPermission + + @staticmethod + def share() -> typing.Type['AacPermission']: + return AacPermission + + @staticmethod + def view() -> typing.Type['AacPermission']: + return AacPermission + __annotations__ = { + "edit": edit, + "share": share, + "view": view, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["edit"]) -> 'AacPermission': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["share"]) -> 'AacPermission': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["view"]) -> 'AacPermission': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["edit", "share", "view", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["edit"]) -> typing.Union['AacPermission', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["share"]) -> typing.Union['AacPermission', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["view"]) -> typing.Union['AacPermission', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["edit", "share", "view", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + edit: typing.Union['AacPermission', schemas.Unset] = schemas.unset, + share: typing.Union['AacPermission', schemas.Unset] = schemas.unset, + view: typing.Union['AacPermission', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacDashboardPermissions': + return super().__new__( + cls, + *_args, + edit=edit, + share=share, + view=view, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_permission import AacPermission diff --git a/gooddata-api-client/gooddata_api_client/model/aac_dashboard_plugin_link.pyi b/gooddata-api-client/gooddata_api_client/model/aac_dashboard_plugin_link.pyi new file mode 100644 index 000000000..beed98b19 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_dashboard_plugin_link.pyi @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacDashboardPluginLink( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Dashboard plugins. + """ + + + class MetaOapg: + required = { + "id", + } + + class properties: + id = schemas.StrSchema + + @staticmethod + def parameters() -> typing.Type['JsonNode']: + return JsonNode + __annotations__ = { + "id": id, + "parameters": parameters, + } + + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["parameters"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "parameters", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["parameters"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "parameters", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + parameters: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacDashboardPluginLink': + return super().__new__( + cls, + *_args, + id=id, + parameters=parameters, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_dashboard_with_tabs.py b/gooddata-api-client/gooddata_api_client/model/aac_dashboard_with_tabs.py index d5666c030..9e7c474ef 100644 --- a/gooddata-api-client/gooddata_api_client/model/aac_dashboard_with_tabs.py +++ b/gooddata-api-client/gooddata_api_client/model/aac_dashboard_with_tabs.py @@ -33,12 +33,10 @@ def lazy_import(): from gooddata_api_client.model.aac_dashboard_filter import AacDashboardFilter from gooddata_api_client.model.aac_dashboard_permissions import AacDashboardPermissions - from gooddata_api_client.model.aac_dashboard_plugin_link import AacDashboardPluginLink from gooddata_api_client.model.aac_section import AacSection from gooddata_api_client.model.aac_tab import AacTab globals()['AacDashboardFilter'] = AacDashboardFilter globals()['AacDashboardPermissions'] = AacDashboardPermissions - globals()['AacDashboardPluginLink'] = AacDashboardPluginLink globals()['AacSection'] = AacSection globals()['AacTab'] = AacTab diff --git a/gooddata-api-client/gooddata_api_client/model/aac_dashboard_with_tabs.pyi b/gooddata-api-client/gooddata_api_client/model/aac_dashboard_with_tabs.pyi new file mode 100644 index 000000000..0b798d9cc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_dashboard_with_tabs.pyi @@ -0,0 +1,474 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacDashboardWithTabs( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "tabs", + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + + class tabs( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacTab']: + return AacTab + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacTab'], typing.List['AacTab']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tabs': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacTab': + return super().__getitem__(i) + type = schemas.StrSchema + active_tab_id = schemas.StrSchema + cross_filtering = schemas.BoolSchema + description = schemas.StrSchema + enable_section_headers = schemas.BoolSchema + filter_views = schemas.BoolSchema + + + class filters( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['AacDashboardFilter']: + return AacDashboardFilter + + def __getitem__(self, name: typing.Union[str, ]) -> 'AacDashboardFilter': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'AacDashboardFilter': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'AacDashboardFilter', + ) -> 'filters': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @staticmethod + def permissions() -> typing.Type['AacDashboardPermissions']: + return AacDashboardPermissions + + + class plugins( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + AacDashboardPluginLink, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'plugins': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class sections( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacSection']: + return AacSection + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacSection'], typing.List['AacSection']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'sections': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacSection': + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + user_filters_reset = schemas.BoolSchema + user_filters_save = schemas.BoolSchema + __annotations__ = { + "id": id, + "tabs": tabs, + "type": type, + "active_tab_id": active_tab_id, + "cross_filtering": cross_filtering, + "description": description, + "enable_section_headers": enable_section_headers, + "filter_views": filter_views, + "filters": filters, + "permissions": permissions, + "plugins": plugins, + "sections": sections, + "tags": tags, + "title": title, + "user_filters_reset": user_filters_reset, + "user_filters_save": user_filters_save, + } + + + class all_of_0( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "sections", + } + + + sections: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + ] + + + tabs: MetaOapg.properties.tabs + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tabs"]) -> MetaOapg.properties.tabs: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["active_tab_id"]) -> MetaOapg.properties.active_tab_id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["cross_filtering"]) -> MetaOapg.properties.cross_filtering: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["enable_section_headers"]) -> MetaOapg.properties.enable_section_headers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filter_views"]) -> MetaOapg.properties.filter_views: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> 'AacDashboardPermissions': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["plugins"]) -> MetaOapg.properties.plugins: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sections"]) -> MetaOapg.properties.sections: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["user_filters_reset"]) -> MetaOapg.properties.user_filters_reset: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["user_filters_save"]) -> MetaOapg.properties.user_filters_save: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "tabs", "type", "active_tab_id", "cross_filtering", "description", "enable_section_headers", "filter_views", "filters", "permissions", "plugins", "sections", "tags", "title", "user_filters_reset", "user_filters_save", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tabs"]) -> MetaOapg.properties.tabs: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["active_tab_id"]) -> typing.Union[MetaOapg.properties.active_tab_id, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["cross_filtering"]) -> typing.Union[MetaOapg.properties.cross_filtering, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["enable_section_headers"]) -> typing.Union[MetaOapg.properties.enable_section_headers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filter_views"]) -> typing.Union[MetaOapg.properties.filter_views, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filters"]) -> typing.Union[MetaOapg.properties.filters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> typing.Union['AacDashboardPermissions', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["plugins"]) -> typing.Union[MetaOapg.properties.plugins, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sections"]) -> typing.Union[MetaOapg.properties.sections, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["user_filters_reset"]) -> typing.Union[MetaOapg.properties.user_filters_reset, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["user_filters_save"]) -> typing.Union[MetaOapg.properties.user_filters_save, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "tabs", "type", "active_tab_id", "cross_filtering", "description", "enable_section_headers", "filter_views", "filters", "permissions", "plugins", "sections", "tags", "title", "user_filters_reset", "user_filters_save", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + tabs: typing.Union[MetaOapg.properties.tabs, list, tuple, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + active_tab_id: typing.Union[MetaOapg.properties.active_tab_id, str, schemas.Unset] = schemas.unset, + cross_filtering: typing.Union[MetaOapg.properties.cross_filtering, bool, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + enable_section_headers: typing.Union[MetaOapg.properties.enable_section_headers, bool, schemas.Unset] = schemas.unset, + filter_views: typing.Union[MetaOapg.properties.filter_views, bool, schemas.Unset] = schemas.unset, + filters: typing.Union[MetaOapg.properties.filters, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + permissions: typing.Union['AacDashboardPermissions', schemas.Unset] = schemas.unset, + plugins: typing.Union[MetaOapg.properties.plugins, list, tuple, schemas.Unset] = schemas.unset, + sections: typing.Union[MetaOapg.properties.sections, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + user_filters_reset: typing.Union[MetaOapg.properties.user_filters_reset, bool, schemas.Unset] = schemas.unset, + user_filters_save: typing.Union[MetaOapg.properties.user_filters_save, bool, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacDashboardWithTabs': + return super().__new__( + cls, + *_args, + tabs=tabs, + id=id, + type=type, + active_tab_id=active_tab_id, + cross_filtering=cross_filtering, + description=description, + enable_section_headers=enable_section_headers, + filter_views=filter_views, + filters=filters, + permissions=permissions, + plugins=plugins, + sections=sections, + tags=tags, + title=title, + user_filters_reset=user_filters_reset, + user_filters_save=user_filters_save, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_dashboard_filter import AacDashboardFilter +from gooddata_api_client.model.aac_dashboard_permissions import AacDashboardPermissions +from gooddata_api_client.model.aac_dashboard_plugin_link import AacDashboardPluginLink +from gooddata_api_client.model.aac_section import AacSection +from gooddata_api_client.model.aac_tab import AacTab diff --git a/gooddata-api-client/gooddata_api_client/model/aac_dashboard_without_tabs.py b/gooddata-api-client/gooddata_api_client/model/aac_dashboard_without_tabs.py index 6c0556f01..367bd29cb 100644 --- a/gooddata-api-client/gooddata_api_client/model/aac_dashboard_without_tabs.py +++ b/gooddata-api-client/gooddata_api_client/model/aac_dashboard_without_tabs.py @@ -33,12 +33,10 @@ def lazy_import(): from gooddata_api_client.model.aac_dashboard_filter import AacDashboardFilter from gooddata_api_client.model.aac_dashboard_permissions import AacDashboardPermissions - from gooddata_api_client.model.aac_dashboard_plugin_link import AacDashboardPluginLink from gooddata_api_client.model.aac_section import AacSection from gooddata_api_client.model.aac_tab import AacTab globals()['AacDashboardFilter'] = AacDashboardFilter globals()['AacDashboardPermissions'] = AacDashboardPermissions - globals()['AacDashboardPluginLink'] = AacDashboardPluginLink globals()['AacSection'] = AacSection globals()['AacTab'] = AacTab diff --git a/gooddata-api-client/gooddata_api_client/model/aac_dashboard_without_tabs.pyi b/gooddata-api-client/gooddata_api_client/model/aac_dashboard_without_tabs.pyi new file mode 100644 index 000000000..3a0166430 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_dashboard_without_tabs.pyi @@ -0,0 +1,522 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacDashboardWithoutTabs( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + id = schemas.StrSchema + type = schemas.StrSchema + active_tab_id = schemas.StrSchema + cross_filtering = schemas.BoolSchema + description = schemas.StrSchema + enable_section_headers = schemas.BoolSchema + filter_views = schemas.BoolSchema + + + class filters( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['AacDashboardFilter']: + return AacDashboardFilter + + def __getitem__(self, name: typing.Union[str, ]) -> 'AacDashboardFilter': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'AacDashboardFilter': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'AacDashboardFilter', + ) -> 'filters': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @staticmethod + def permissions() -> typing.Type['AacDashboardPermissions']: + return AacDashboardPermissions + + + class plugins( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + AacDashboardPluginLink, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'plugins': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class sections( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacSection']: + return AacSection + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacSection'], typing.List['AacSection']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'sections': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacSection': + return super().__getitem__(i) + + + class tabs( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacTab']: + return AacTab + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacTab'], typing.List['AacTab']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tabs': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacTab': + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + user_filters_reset = schemas.BoolSchema + user_filters_save = schemas.BoolSchema + __annotations__ = { + "id": id, + "type": type, + "active_tab_id": active_tab_id, + "cross_filtering": cross_filtering, + "description": description, + "enable_section_headers": enable_section_headers, + "filter_views": filter_views, + "filters": filters, + "permissions": permissions, + "plugins": plugins, + "sections": sections, + "tabs": tabs, + "tags": tags, + "title": title, + "user_filters_reset": user_filters_reset, + "user_filters_save": user_filters_save, + } + + + class all_of_0( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "tabs", + } + + + tabs: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_1( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "active_tab_id", + } + + + active_tab_id: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + cls.all_of_1, + ] + + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["active_tab_id"]) -> MetaOapg.properties.active_tab_id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["cross_filtering"]) -> MetaOapg.properties.cross_filtering: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["enable_section_headers"]) -> MetaOapg.properties.enable_section_headers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filter_views"]) -> MetaOapg.properties.filter_views: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> 'AacDashboardPermissions': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["plugins"]) -> MetaOapg.properties.plugins: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sections"]) -> MetaOapg.properties.sections: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tabs"]) -> MetaOapg.properties.tabs: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["user_filters_reset"]) -> MetaOapg.properties.user_filters_reset: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["user_filters_save"]) -> MetaOapg.properties.user_filters_save: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "active_tab_id", "cross_filtering", "description", "enable_section_headers", "filter_views", "filters", "permissions", "plugins", "sections", "tabs", "tags", "title", "user_filters_reset", "user_filters_save", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["active_tab_id"]) -> typing.Union[MetaOapg.properties.active_tab_id, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["cross_filtering"]) -> typing.Union[MetaOapg.properties.cross_filtering, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["enable_section_headers"]) -> typing.Union[MetaOapg.properties.enable_section_headers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filter_views"]) -> typing.Union[MetaOapg.properties.filter_views, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filters"]) -> typing.Union[MetaOapg.properties.filters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> typing.Union['AacDashboardPermissions', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["plugins"]) -> typing.Union[MetaOapg.properties.plugins, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sections"]) -> typing.Union[MetaOapg.properties.sections, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tabs"]) -> typing.Union[MetaOapg.properties.tabs, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["user_filters_reset"]) -> typing.Union[MetaOapg.properties.user_filters_reset, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["user_filters_save"]) -> typing.Union[MetaOapg.properties.user_filters_save, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "active_tab_id", "cross_filtering", "description", "enable_section_headers", "filter_views", "filters", "permissions", "plugins", "sections", "tabs", "tags", "title", "user_filters_reset", "user_filters_save", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + active_tab_id: typing.Union[MetaOapg.properties.active_tab_id, str, schemas.Unset] = schemas.unset, + cross_filtering: typing.Union[MetaOapg.properties.cross_filtering, bool, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + enable_section_headers: typing.Union[MetaOapg.properties.enable_section_headers, bool, schemas.Unset] = schemas.unset, + filter_views: typing.Union[MetaOapg.properties.filter_views, bool, schemas.Unset] = schemas.unset, + filters: typing.Union[MetaOapg.properties.filters, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + permissions: typing.Union['AacDashboardPermissions', schemas.Unset] = schemas.unset, + plugins: typing.Union[MetaOapg.properties.plugins, list, tuple, schemas.Unset] = schemas.unset, + sections: typing.Union[MetaOapg.properties.sections, list, tuple, schemas.Unset] = schemas.unset, + tabs: typing.Union[MetaOapg.properties.tabs, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + user_filters_reset: typing.Union[MetaOapg.properties.user_filters_reset, bool, schemas.Unset] = schemas.unset, + user_filters_save: typing.Union[MetaOapg.properties.user_filters_save, bool, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacDashboardWithoutTabs': + return super().__new__( + cls, + *_args, + id=id, + type=type, + active_tab_id=active_tab_id, + cross_filtering=cross_filtering, + description=description, + enable_section_headers=enable_section_headers, + filter_views=filter_views, + filters=filters, + permissions=permissions, + plugins=plugins, + sections=sections, + tabs=tabs, + tags=tags, + title=title, + user_filters_reset=user_filters_reset, + user_filters_save=user_filters_save, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_dashboard_filter import AacDashboardFilter +from gooddata_api_client.model.aac_dashboard_permissions import AacDashboardPermissions +from gooddata_api_client.model.aac_dashboard_plugin_link import AacDashboardPluginLink +from gooddata_api_client.model.aac_section import AacSection +from gooddata_api_client.model.aac_tab import AacTab diff --git a/gooddata-api-client/gooddata_api_client/model/aac_dataset.pyi b/gooddata-api-client/gooddata_api_client/model/aac_dataset.pyi new file mode 100644 index 000000000..9f6b35634 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_dataset.pyi @@ -0,0 +1,377 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacDataset( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + AAC dataset definition. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + id = schemas.StrSchema + type = schemas.StrSchema + data_source = schemas.StrSchema + description = schemas.StrSchema + + + class fields( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['AacField']: + return AacField + + def __getitem__(self, name: typing.Union[str, ]) -> 'AacField': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'AacField': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'AacField', + ) -> 'fields': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + precedence = schemas.Int32Schema + + + class primary_key( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + + + class one_of_1( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'one_of_1': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'primary_key': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class references( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacReference']: + return AacReference + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacReference'], typing.List['AacReference']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'references': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacReference': + return super().__getitem__(i) + sql = schemas.StrSchema + table_path = schemas.StrSchema + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + + + class workspace_data_filters( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacWorkspaceDataFilter']: + return AacWorkspaceDataFilter + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacWorkspaceDataFilter'], typing.List['AacWorkspaceDataFilter']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'workspace_data_filters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacWorkspaceDataFilter': + return super().__getitem__(i) + __annotations__ = { + "id": id, + "type": type, + "data_source": data_source, + "description": description, + "fields": fields, + "precedence": precedence, + "primary_key": primary_key, + "references": references, + "sql": sql, + "table_path": table_path, + "tags": tags, + "title": title, + "workspace_data_filters": workspace_data_filters, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data_source"]) -> MetaOapg.properties.data_source: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fields"]) -> MetaOapg.properties.fields: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["precedence"]) -> MetaOapg.properties.precedence: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["primary_key"]) -> MetaOapg.properties.primary_key: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["references"]) -> MetaOapg.properties.references: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sql"]) -> MetaOapg.properties.sql: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["table_path"]) -> MetaOapg.properties.table_path: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workspace_data_filters"]) -> MetaOapg.properties.workspace_data_filters: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "data_source", "description", "fields", "precedence", "primary_key", "references", "sql", "table_path", "tags", "title", "workspace_data_filters", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data_source"]) -> typing.Union[MetaOapg.properties.data_source, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fields"]) -> typing.Union[MetaOapg.properties.fields, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["precedence"]) -> typing.Union[MetaOapg.properties.precedence, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["primary_key"]) -> typing.Union[MetaOapg.properties.primary_key, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["references"]) -> typing.Union[MetaOapg.properties.references, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sql"]) -> typing.Union[MetaOapg.properties.sql, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["table_path"]) -> typing.Union[MetaOapg.properties.table_path, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workspace_data_filters"]) -> typing.Union[MetaOapg.properties.workspace_data_filters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "data_source", "description", "fields", "precedence", "primary_key", "references", "sql", "table_path", "tags", "title", "workspace_data_filters", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + data_source: typing.Union[MetaOapg.properties.data_source, str, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + fields: typing.Union[MetaOapg.properties.fields, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + precedence: typing.Union[MetaOapg.properties.precedence, decimal.Decimal, int, schemas.Unset] = schemas.unset, + primary_key: typing.Union[MetaOapg.properties.primary_key, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + references: typing.Union[MetaOapg.properties.references, list, tuple, schemas.Unset] = schemas.unset, + sql: typing.Union[MetaOapg.properties.sql, str, schemas.Unset] = schemas.unset, + table_path: typing.Union[MetaOapg.properties.table_path, str, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + workspace_data_filters: typing.Union[MetaOapg.properties.workspace_data_filters, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacDataset': + return super().__new__( + cls, + *_args, + id=id, + type=type, + data_source=data_source, + description=description, + fields=fields, + precedence=precedence, + primary_key=primary_key, + references=references, + sql=sql, + table_path=table_path, + tags=tags, + title=title, + workspace_data_filters=workspace_data_filters, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_field import AacField +from gooddata_api_client.model.aac_reference import AacReference +from gooddata_api_client.model.aac_workspace_data_filter import AacWorkspaceDataFilter diff --git a/gooddata-api-client/gooddata_api_client/model/aac_date_dataset.pyi b/gooddata-api-client/gooddata_api_client/model/aac_date_dataset.pyi new file mode 100644 index 000000000..99db40b73 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_date_dataset.pyi @@ -0,0 +1,202 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacDateDataset( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + AAC date dataset definition. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + id = schemas.StrSchema + type = schemas.StrSchema + description = schemas.StrSchema + + + class granularities( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'granularities': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + title_base = schemas.StrSchema + title_pattern = schemas.StrSchema + __annotations__ = { + "id": id, + "type": type, + "description": description, + "granularities": granularities, + "tags": tags, + "title": title, + "title_base": title_base, + "title_pattern": title_pattern, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["granularities"]) -> MetaOapg.properties.granularities: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title_base"]) -> MetaOapg.properties.title_base: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title_pattern"]) -> MetaOapg.properties.title_pattern: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "description", "granularities", "tags", "title", "title_base", "title_pattern", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["granularities"]) -> typing.Union[MetaOapg.properties.granularities, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title_base"]) -> typing.Union[MetaOapg.properties.title_base, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title_pattern"]) -> typing.Union[MetaOapg.properties.title_pattern, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "description", "granularities", "tags", "title", "title_base", "title_pattern", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + granularities: typing.Union[MetaOapg.properties.granularities, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + title_base: typing.Union[MetaOapg.properties.title_base, str, schemas.Unset] = schemas.unset, + title_pattern: typing.Union[MetaOapg.properties.title_pattern, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacDateDataset': + return super().__new__( + cls, + *_args, + id=id, + type=type, + description=description, + granularities=granularities, + tags=tags, + title=title, + title_base=title_base, + title_pattern=title_pattern, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/aac_field.pyi b/gooddata-api-client/gooddata_api_client/model/aac_field.pyi new file mode 100644 index 000000000..cb6ad9842 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_field.pyi @@ -0,0 +1,327 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacField( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + AAC field definition (attribute, fact, or aggregated_fact). + """ + + + class MetaOapg: + required = { + "type", + } + + class properties: + type = schemas.StrSchema + aggregated_as = schemas.StrSchema + assigned_to = schemas.StrSchema + + + class data_type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INT(cls): + return cls("INT") + + @schemas.classproperty + def STRING(cls): + return cls("STRING") + + @schemas.classproperty + def DATE(cls): + return cls("DATE") + + @schemas.classproperty + def NUMERIC(cls): + return cls("NUMERIC") + + @schemas.classproperty + def TIMESTAMP(cls): + return cls("TIMESTAMP") + + @schemas.classproperty + def TIMESTAMP_TZ(cls): + return cls("TIMESTAMP_TZ") + + @schemas.classproperty + def BOOLEAN(cls): + return cls("BOOLEAN") + default_view = schemas.StrSchema + description = schemas.StrSchema + is_hidden = schemas.BoolSchema + + + class labels( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['AacLabel']: + return AacLabel + + def __getitem__(self, name: typing.Union[str, ]) -> 'AacLabel': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'AacLabel': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'AacLabel', + ) -> 'labels': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + locale = schemas.StrSchema + show_in_ai_results = schemas.BoolSchema + sort_column = schemas.StrSchema + + + class sort_direction( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ASC(cls): + return cls("ASC") + + @schemas.classproperty + def DESC(cls): + return cls("DESC") + source_column = schemas.StrSchema + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + __annotations__ = { + "type": type, + "aggregated_as": aggregated_as, + "assigned_to": assigned_to, + "data_type": data_type, + "default_view": default_view, + "description": description, + "is_hidden": is_hidden, + "labels": labels, + "locale": locale, + "show_in_ai_results": show_in_ai_results, + "sort_column": sort_column, + "sort_direction": sort_direction, + "source_column": source_column, + "tags": tags, + "title": title, + } + + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["aggregated_as"]) -> MetaOapg.properties.aggregated_as: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["assigned_to"]) -> MetaOapg.properties.assigned_to: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data_type"]) -> MetaOapg.properties.data_type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["default_view"]) -> MetaOapg.properties.default_view: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["is_hidden"]) -> MetaOapg.properties.is_hidden: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["labels"]) -> MetaOapg.properties.labels: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["locale"]) -> MetaOapg.properties.locale: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["show_in_ai_results"]) -> MetaOapg.properties.show_in_ai_results: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sort_column"]) -> MetaOapg.properties.sort_column: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sort_direction"]) -> MetaOapg.properties.sort_direction: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["source_column"]) -> MetaOapg.properties.source_column: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["type", "aggregated_as", "assigned_to", "data_type", "default_view", "description", "is_hidden", "labels", "locale", "show_in_ai_results", "sort_column", "sort_direction", "source_column", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["aggregated_as"]) -> typing.Union[MetaOapg.properties.aggregated_as, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["assigned_to"]) -> typing.Union[MetaOapg.properties.assigned_to, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data_type"]) -> typing.Union[MetaOapg.properties.data_type, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["default_view"]) -> typing.Union[MetaOapg.properties.default_view, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["is_hidden"]) -> typing.Union[MetaOapg.properties.is_hidden, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["labels"]) -> typing.Union[MetaOapg.properties.labels, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["locale"]) -> typing.Union[MetaOapg.properties.locale, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["show_in_ai_results"]) -> typing.Union[MetaOapg.properties.show_in_ai_results, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sort_column"]) -> typing.Union[MetaOapg.properties.sort_column, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sort_direction"]) -> typing.Union[MetaOapg.properties.sort_direction, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["source_column"]) -> typing.Union[MetaOapg.properties.source_column, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["type", "aggregated_as", "assigned_to", "data_type", "default_view", "description", "is_hidden", "labels", "locale", "show_in_ai_results", "sort_column", "sort_direction", "source_column", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + aggregated_as: typing.Union[MetaOapg.properties.aggregated_as, str, schemas.Unset] = schemas.unset, + assigned_to: typing.Union[MetaOapg.properties.assigned_to, str, schemas.Unset] = schemas.unset, + data_type: typing.Union[MetaOapg.properties.data_type, str, schemas.Unset] = schemas.unset, + default_view: typing.Union[MetaOapg.properties.default_view, str, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + is_hidden: typing.Union[MetaOapg.properties.is_hidden, bool, schemas.Unset] = schemas.unset, + labels: typing.Union[MetaOapg.properties.labels, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + locale: typing.Union[MetaOapg.properties.locale, str, schemas.Unset] = schemas.unset, + show_in_ai_results: typing.Union[MetaOapg.properties.show_in_ai_results, bool, schemas.Unset] = schemas.unset, + sort_column: typing.Union[MetaOapg.properties.sort_column, str, schemas.Unset] = schemas.unset, + sort_direction: typing.Union[MetaOapg.properties.sort_direction, str, schemas.Unset] = schemas.unset, + source_column: typing.Union[MetaOapg.properties.source_column, str, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacField': + return super().__new__( + cls, + *_args, + type=type, + aggregated_as=aggregated_as, + assigned_to=assigned_to, + data_type=data_type, + default_view=default_view, + description=description, + is_hidden=is_hidden, + labels=labels, + locale=locale, + show_in_ai_results=show_in_ai_results, + sort_column=sort_column, + sort_direction=sort_direction, + source_column=source_column, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_label import AacLabel diff --git a/gooddata-api-client/gooddata_api_client/model/aac_filter_state.pyi b/gooddata-api-client/gooddata_api_client/model/aac_filter_state.pyi new file mode 100644 index 000000000..be9ba8a00 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_filter_state.pyi @@ -0,0 +1,135 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacFilterState( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Filter state. + """ + + + class MetaOapg: + + class properties: + + + class exclude( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'exclude': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class include( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'include': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "exclude": exclude, + "include": include, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["exclude"]) -> MetaOapg.properties.exclude: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["include"]) -> MetaOapg.properties.include: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["exclude", "include", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["exclude"]) -> typing.Union[MetaOapg.properties.exclude, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["include"]) -> typing.Union[MetaOapg.properties.include, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["exclude", "include", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + exclude: typing.Union[MetaOapg.properties.exclude, list, tuple, schemas.Unset] = schemas.unset, + include: typing.Union[MetaOapg.properties.include, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacFilterState': + return super().__new__( + cls, + *_args, + exclude=exclude, + include=include, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/aac_geo_area_config.pyi b/gooddata-api-client/gooddata_api_client/model/aac_geo_area_config.pyi new file mode 100644 index 000000000..eaada0035 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_geo_area_config.pyi @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacGeoAreaConfig( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + GEO area configuration. + """ + + + class MetaOapg: + required = { + "collection", + } + + class properties: + + @staticmethod + def collection() -> typing.Type['AacGeoCollectionIdentifier']: + return AacGeoCollectionIdentifier + __annotations__ = { + "collection": collection, + } + + collection: 'AacGeoCollectionIdentifier' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["collection"]) -> 'AacGeoCollectionIdentifier': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["collection", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["collection"]) -> 'AacGeoCollectionIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["collection", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + collection: 'AacGeoCollectionIdentifier', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacGeoAreaConfig': + return super().__new__( + cls, + *_args, + collection=collection, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_geo_collection_identifier import AacGeoCollectionIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/aac_geo_collection_identifier.pyi b/gooddata-api-client/gooddata_api_client/model/aac_geo_collection_identifier.pyi new file mode 100644 index 000000000..4cd808589 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_geo_collection_identifier.pyi @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacGeoCollectionIdentifier( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + GEO collection configuration. + """ + + + class MetaOapg: + required = { + "id", + } + + class properties: + id = schemas.StrSchema + + + class kind( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def STATIC(cls): + return cls("STATIC") + + @schemas.classproperty + def CUSTOM(cls): + return cls("CUSTOM") + __annotations__ = { + "id": id, + "kind": kind, + } + + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["kind"]) -> MetaOapg.properties.kind: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "kind", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["kind"]) -> typing.Union[MetaOapg.properties.kind, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "kind", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + kind: typing.Union[MetaOapg.properties.kind, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacGeoCollectionIdentifier': + return super().__new__( + cls, + *_args, + id=id, + kind=kind, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/aac_label.pyi b/gooddata-api-client/gooddata_api_client/model/aac_label.pyi new file mode 100644 index 000000000..0c9bec14f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_label.pyi @@ -0,0 +1,267 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacLabel( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + AAC label definition. + """ + + + class MetaOapg: + + class properties: + + + class data_type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INT(cls): + return cls("INT") + + @schemas.classproperty + def STRING(cls): + return cls("STRING") + + @schemas.classproperty + def DATE(cls): + return cls("DATE") + + @schemas.classproperty + def NUMERIC(cls): + return cls("NUMERIC") + + @schemas.classproperty + def TIMESTAMP(cls): + return cls("TIMESTAMP") + + @schemas.classproperty + def TIMESTAMP_TZ(cls): + return cls("TIMESTAMP_TZ") + + @schemas.classproperty + def BOOLEAN(cls): + return cls("BOOLEAN") + description = schemas.StrSchema + + @staticmethod + def geo_area_config() -> typing.Type['AacGeoAreaConfig']: + return AacGeoAreaConfig + is_hidden = schemas.BoolSchema + locale = schemas.StrSchema + show_in_ai_results = schemas.BoolSchema + source_column = schemas.StrSchema + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + + + class translations( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacLabelTranslation']: + return AacLabelTranslation + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacLabelTranslation'], typing.List['AacLabelTranslation']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'translations': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacLabelTranslation': + return super().__getitem__(i) + value_type = schemas.StrSchema + __annotations__ = { + "data_type": data_type, + "description": description, + "geo_area_config": geo_area_config, + "is_hidden": is_hidden, + "locale": locale, + "show_in_ai_results": show_in_ai_results, + "source_column": source_column, + "tags": tags, + "title": title, + "translations": translations, + "value_type": value_type, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data_type"]) -> MetaOapg.properties.data_type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["geo_area_config"]) -> 'AacGeoAreaConfig': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["is_hidden"]) -> MetaOapg.properties.is_hidden: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["locale"]) -> MetaOapg.properties.locale: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["show_in_ai_results"]) -> MetaOapg.properties.show_in_ai_results: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["source_column"]) -> MetaOapg.properties.source_column: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["translations"]) -> MetaOapg.properties.translations: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["value_type"]) -> MetaOapg.properties.value_type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data_type", "description", "geo_area_config", "is_hidden", "locale", "show_in_ai_results", "source_column", "tags", "title", "translations", "value_type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data_type"]) -> typing.Union[MetaOapg.properties.data_type, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["geo_area_config"]) -> typing.Union['AacGeoAreaConfig', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["is_hidden"]) -> typing.Union[MetaOapg.properties.is_hidden, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["locale"]) -> typing.Union[MetaOapg.properties.locale, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["show_in_ai_results"]) -> typing.Union[MetaOapg.properties.show_in_ai_results, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["source_column"]) -> typing.Union[MetaOapg.properties.source_column, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["translations"]) -> typing.Union[MetaOapg.properties.translations, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["value_type"]) -> typing.Union[MetaOapg.properties.value_type, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data_type", "description", "geo_area_config", "is_hidden", "locale", "show_in_ai_results", "source_column", "tags", "title", "translations", "value_type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data_type: typing.Union[MetaOapg.properties.data_type, str, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + geo_area_config: typing.Union['AacGeoAreaConfig', schemas.Unset] = schemas.unset, + is_hidden: typing.Union[MetaOapg.properties.is_hidden, bool, schemas.Unset] = schemas.unset, + locale: typing.Union[MetaOapg.properties.locale, str, schemas.Unset] = schemas.unset, + show_in_ai_results: typing.Union[MetaOapg.properties.show_in_ai_results, bool, schemas.Unset] = schemas.unset, + source_column: typing.Union[MetaOapg.properties.source_column, str, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + translations: typing.Union[MetaOapg.properties.translations, list, tuple, schemas.Unset] = schemas.unset, + value_type: typing.Union[MetaOapg.properties.value_type, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacLabel': + return super().__new__( + cls, + *_args, + data_type=data_type, + description=description, + geo_area_config=geo_area_config, + is_hidden=is_hidden, + locale=locale, + show_in_ai_results=show_in_ai_results, + source_column=source_column, + tags=tags, + title=title, + translations=translations, + value_type=value_type, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_geo_area_config import AacGeoAreaConfig +from gooddata_api_client.model.aac_label_translation import AacLabelTranslation diff --git a/gooddata-api-client/gooddata_api_client/model/aac_label_translation.pyi b/gooddata-api-client/gooddata_api_client/model/aac_label_translation.pyi new file mode 100644 index 000000000..922b83fcc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_label_translation.pyi @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacLabelTranslation( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Localized source columns. + """ + + + class MetaOapg: + required = { + "source_column", + "locale", + } + + class properties: + locale = schemas.StrSchema + source_column = schemas.StrSchema + __annotations__ = { + "locale": locale, + "source_column": source_column, + } + + source_column: MetaOapg.properties.source_column + locale: MetaOapg.properties.locale + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["locale"]) -> MetaOapg.properties.locale: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["source_column"]) -> MetaOapg.properties.source_column: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["locale", "source_column", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["locale"]) -> MetaOapg.properties.locale: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["source_column"]) -> MetaOapg.properties.source_column: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["locale", "source_column", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + source_column: typing.Union[MetaOapg.properties.source_column, str, ], + locale: typing.Union[MetaOapg.properties.locale, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacLabelTranslation': + return super().__new__( + cls, + *_args, + source_column=source_column, + locale=locale, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/aac_logical_model.pyi b/gooddata-api-client/gooddata_api_client/model/aac_logical_model.pyi new file mode 100644 index 000000000..d5c752f09 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_logical_model.pyi @@ -0,0 +1,144 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacLogicalModel( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + AAC logical data model representation compatible with Analytics-as-Code YAML format. + """ + + + class MetaOapg: + + class properties: + + + class datasets( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacDataset']: + return AacDataset + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacDataset'], typing.List['AacDataset']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'datasets': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacDataset': + return super().__getitem__(i) + + + class date_datasets( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacDateDataset']: + return AacDateDataset + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacDateDataset'], typing.List['AacDateDataset']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'date_datasets': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacDateDataset': + return super().__getitem__(i) + __annotations__ = { + "datasets": datasets, + "date_datasets": date_datasets, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["datasets"]) -> MetaOapg.properties.datasets: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["date_datasets"]) -> MetaOapg.properties.date_datasets: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["datasets", "date_datasets", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["datasets"]) -> typing.Union[MetaOapg.properties.datasets, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["date_datasets"]) -> typing.Union[MetaOapg.properties.date_datasets, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["datasets", "date_datasets", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + datasets: typing.Union[MetaOapg.properties.datasets, list, tuple, schemas.Unset] = schemas.unset, + date_datasets: typing.Union[MetaOapg.properties.date_datasets, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacLogicalModel': + return super().__new__( + cls, + *_args, + datasets=datasets, + date_datasets=date_datasets, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_dataset import AacDataset +from gooddata_api_client.model.aac_date_dataset import AacDateDataset diff --git a/gooddata-api-client/gooddata_api_client/model/aac_metric.pyi b/gooddata-api-client/gooddata_api_client/model/aac_metric.pyi new file mode 100644 index 000000000..6f81b8cc4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_metric.pyi @@ -0,0 +1,202 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacMetric( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + AAC metric definition. + """ + + + class MetaOapg: + required = { + "id", + "maql", + "type", + } + + class properties: + id = schemas.StrSchema + maql = schemas.StrSchema + type = schemas.StrSchema + description = schemas.StrSchema + format = schemas.StrSchema + is_hidden = schemas.BoolSchema + is_hidden_from_kda = schemas.BoolSchema + show_in_ai_results = schemas.BoolSchema + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + __annotations__ = { + "id": id, + "maql": maql, + "type": type, + "description": description, + "format": format, + "is_hidden": is_hidden, + "is_hidden_from_kda": is_hidden_from_kda, + "show_in_ai_results": show_in_ai_results, + "tags": tags, + "title": title, + } + + id: MetaOapg.properties.id + maql: MetaOapg.properties.maql + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["maql"]) -> MetaOapg.properties.maql: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["is_hidden"]) -> MetaOapg.properties.is_hidden: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["is_hidden_from_kda"]) -> MetaOapg.properties.is_hidden_from_kda: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["show_in_ai_results"]) -> MetaOapg.properties.show_in_ai_results: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "maql", "type", "description", "format", "is_hidden", "is_hidden_from_kda", "show_in_ai_results", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["maql"]) -> MetaOapg.properties.maql: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["format"]) -> typing.Union[MetaOapg.properties.format, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["is_hidden"]) -> typing.Union[MetaOapg.properties.is_hidden, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["is_hidden_from_kda"]) -> typing.Union[MetaOapg.properties.is_hidden_from_kda, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["show_in_ai_results"]) -> typing.Union[MetaOapg.properties.show_in_ai_results, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "maql", "type", "description", "format", "is_hidden", "is_hidden_from_kda", "show_in_ai_results", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + maql: typing.Union[MetaOapg.properties.maql, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + format: typing.Union[MetaOapg.properties.format, str, schemas.Unset] = schemas.unset, + is_hidden: typing.Union[MetaOapg.properties.is_hidden, bool, schemas.Unset] = schemas.unset, + is_hidden_from_kda: typing.Union[MetaOapg.properties.is_hidden_from_kda, bool, schemas.Unset] = schemas.unset, + show_in_ai_results: typing.Union[MetaOapg.properties.show_in_ai_results, bool, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacMetric': + return super().__new__( + cls, + *_args, + id=id, + maql=maql, + type=type, + description=description, + format=format, + is_hidden=is_hidden, + is_hidden_from_kda=is_hidden_from_kda, + show_in_ai_results=show_in_ai_results, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/aac_permission.pyi b/gooddata-api-client/gooddata_api_client/model/aac_permission.pyi new file mode 100644 index 000000000..2925e485d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_permission.pyi @@ -0,0 +1,145 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacPermission( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + SHARE permission. + """ + + + class MetaOapg: + + class properties: + all = schemas.BoolSchema + + + class user_groups( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'user_groups': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class users( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'users': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "all": all, + "user_groups": user_groups, + "users": users, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["all"]) -> MetaOapg.properties.all: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["user_groups"]) -> MetaOapg.properties.user_groups: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["all", "user_groups", "users", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["all"]) -> typing.Union[MetaOapg.properties.all, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["user_groups"]) -> typing.Union[MetaOapg.properties.user_groups, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["users"]) -> typing.Union[MetaOapg.properties.users, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["all", "user_groups", "users", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + all: typing.Union[MetaOapg.properties.all, bool, schemas.Unset] = schemas.unset, + user_groups: typing.Union[MetaOapg.properties.user_groups, list, tuple, schemas.Unset] = schemas.unset, + users: typing.Union[MetaOapg.properties.users, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacPermission': + return super().__new__( + cls, + *_args, + all=all, + user_groups=user_groups, + users=users, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/aac_plugin.pyi b/gooddata-api-client/gooddata_api_client/model/aac_plugin.pyi new file mode 100644 index 000000000..649157714 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_plugin.pyi @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacPlugin( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + AAC dashboard plugin definition. + """ + + + class MetaOapg: + required = { + "id", + "type", + "url", + } + + class properties: + id = schemas.StrSchema + type = schemas.StrSchema + url = schemas.StrSchema + description = schemas.StrSchema + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + __annotations__ = { + "id": id, + "type": type, + "url": url, + "description": description, + "tags": tags, + "title": title, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + url: MetaOapg.properties.url + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["url"]) -> MetaOapg.properties.url: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "url", "description", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["url"]) -> MetaOapg.properties.url: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "url", "description", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + url: typing.Union[MetaOapg.properties.url, str, ], + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacPlugin': + return super().__new__( + cls, + *_args, + id=id, + type=type, + url=url, + description=description, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/aac_query.pyi b/gooddata-api-client/gooddata_api_client/model/aac_query.pyi new file mode 100644 index 000000000..63d2e00a1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_query.pyi @@ -0,0 +1,233 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacQuery( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Query definition. + """ + + + class MetaOapg: + required = { + "fields", + } + + class properties: + + + class fields( + schemas.DictSchema + ): + + + class MetaOapg: + + + class additional_properties( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'additional_properties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + ) -> 'fields': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class filter_by( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['AacQueryFilter']: + return AacQueryFilter + + def __getitem__(self, name: typing.Union[str, ]) -> 'AacQueryFilter': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'AacQueryFilter': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'AacQueryFilter', + ) -> 'filter_by': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class sort_by( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonNode']: + return JsonNode + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonNode'], typing.List['JsonNode']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'sort_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonNode': + return super().__getitem__(i) + __annotations__ = { + "fields": fields, + "filter_by": filter_by, + "sort_by": sort_by, + } + + fields: MetaOapg.properties.fields + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fields"]) -> MetaOapg.properties.fields: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filter_by"]) -> MetaOapg.properties.filter_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sort_by"]) -> MetaOapg.properties.sort_by: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["fields", "filter_by", "sort_by", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fields"]) -> MetaOapg.properties.fields: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filter_by"]) -> typing.Union[MetaOapg.properties.filter_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sort_by"]) -> typing.Union[MetaOapg.properties.sort_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["fields", "filter_by", "sort_by", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + fields: typing.Union[MetaOapg.properties.fields, dict, frozendict.frozendict, ], + filter_by: typing.Union[MetaOapg.properties.filter_by, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + sort_by: typing.Union[MetaOapg.properties.sort_by, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacQuery': + return super().__new__( + cls, + *_args, + fields=fields, + filter_by=filter_by, + sort_by=sort_by, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_query_filter import AacQueryFilter +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_query_filter.pyi b/gooddata-api-client/gooddata_api_client/model/aac_query_filter.pyi new file mode 100644 index 000000000..01fa9d53a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_query_filter.pyi @@ -0,0 +1,359 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacQueryFilter( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Layer filters. + """ + + + class MetaOapg: + required = { + "type", + } + + class properties: + type = schemas.StrSchema + + + class additionalProperties( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['JsonNode']: + return JsonNode + + def __getitem__(self, name: typing.Union[str, ]) -> 'JsonNode': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'JsonNode': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'JsonNode', + ) -> 'additionalProperties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + attribute = schemas.StrSchema + bottom = schemas.Int32Schema + condition = schemas.StrSchema + + + class dimensionality( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dimensionality': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + display_as = schemas.StrSchema + + + class _from( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.Int32Schema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> '_from': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + granularity = schemas.StrSchema + null_values_as_zero = schemas.BoolSchema + + @staticmethod + def state() -> typing.Type['AacFilterState']: + return AacFilterState + + + class to( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.Int32Schema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'to': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + top = schemas.Int32Schema + using = schemas.StrSchema + value = schemas.NumberSchema + __annotations__ = { + "type": type, + "additionalProperties": additionalProperties, + "attribute": attribute, + "bottom": bottom, + "condition": condition, + "dimensionality": dimensionality, + "display_as": display_as, + "from": _from, + "granularity": granularity, + "null_values_as_zero": null_values_as_zero, + "state": state, + "to": to, + "top": top, + "using": using, + "value": value, + } + + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["additionalProperties"]) -> MetaOapg.properties.additionalProperties: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attribute"]) -> MetaOapg.properties.attribute: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["bottom"]) -> MetaOapg.properties.bottom: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["condition"]) -> MetaOapg.properties.condition: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dimensionality"]) -> MetaOapg.properties.dimensionality: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["display_as"]) -> MetaOapg.properties.display_as: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["null_values_as_zero"]) -> MetaOapg.properties.null_values_as_zero: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["state"]) -> 'AacFilterState': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> MetaOapg.properties.to: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["top"]) -> MetaOapg.properties.top: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["using"]) -> MetaOapg.properties.using: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["type", "additionalProperties", "attribute", "bottom", "condition", "dimensionality", "display_as", "from", "granularity", "null_values_as_zero", "state", "to", "top", "using", "value", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["additionalProperties"]) -> typing.Union[MetaOapg.properties.additionalProperties, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attribute"]) -> typing.Union[MetaOapg.properties.attribute, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["bottom"]) -> typing.Union[MetaOapg.properties.bottom, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["condition"]) -> typing.Union[MetaOapg.properties.condition, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dimensionality"]) -> typing.Union[MetaOapg.properties.dimensionality, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["display_as"]) -> typing.Union[MetaOapg.properties.display_as, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> typing.Union[MetaOapg.properties._from, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["granularity"]) -> typing.Union[MetaOapg.properties.granularity, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["null_values_as_zero"]) -> typing.Union[MetaOapg.properties.null_values_as_zero, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["state"]) -> typing.Union['AacFilterState', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> typing.Union[MetaOapg.properties.to, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["top"]) -> typing.Union[MetaOapg.properties.top, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["using"]) -> typing.Union[MetaOapg.properties.using, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["value"]) -> typing.Union[MetaOapg.properties.value, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["type", "additionalProperties", "attribute", "bottom", "condition", "dimensionality", "display_as", "from", "granularity", "null_values_as_zero", "state", "to", "top", "using", "value", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + additionalProperties: typing.Union[MetaOapg.properties.additionalProperties, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + attribute: typing.Union[MetaOapg.properties.attribute, str, schemas.Unset] = schemas.unset, + bottom: typing.Union[MetaOapg.properties.bottom, decimal.Decimal, int, schemas.Unset] = schemas.unset, + condition: typing.Union[MetaOapg.properties.condition, str, schemas.Unset] = schemas.unset, + dimensionality: typing.Union[MetaOapg.properties.dimensionality, list, tuple, schemas.Unset] = schemas.unset, + display_as: typing.Union[MetaOapg.properties.display_as, str, schemas.Unset] = schemas.unset, + granularity: typing.Union[MetaOapg.properties.granularity, str, schemas.Unset] = schemas.unset, + null_values_as_zero: typing.Union[MetaOapg.properties.null_values_as_zero, bool, schemas.Unset] = schemas.unset, + state: typing.Union['AacFilterState', schemas.Unset] = schemas.unset, + to: typing.Union[MetaOapg.properties.to, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + top: typing.Union[MetaOapg.properties.top, decimal.Decimal, int, schemas.Unset] = schemas.unset, + using: typing.Union[MetaOapg.properties.using, str, schemas.Unset] = schemas.unset, + value: typing.Union[MetaOapg.properties.value, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacQueryFilter': + return super().__new__( + cls, + *_args, + type=type, + additionalProperties=additionalProperties, + attribute=attribute, + bottom=bottom, + condition=condition, + dimensionality=dimensionality, + display_as=display_as, + granularity=granularity, + null_values_as_zero=null_values_as_zero, + state=state, + to=to, + top=top, + using=using, + value=value, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_filter_state import AacFilterState +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_reference.pyi b/gooddata-api-client/gooddata_api_client/model/aac_reference.pyi new file mode 100644 index 000000000..fea29bd48 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_reference.pyi @@ -0,0 +1,135 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacReference( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + AAC reference to another dataset. + """ + + + class MetaOapg: + required = { + "sources", + "dataset", + } + + class properties: + dataset = schemas.StrSchema + + + class sources( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacReferenceSource']: + return AacReferenceSource + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacReferenceSource'], typing.List['AacReferenceSource']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'sources': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacReferenceSource': + return super().__getitem__(i) + multi_directional = schemas.BoolSchema + __annotations__ = { + "dataset": dataset, + "sources": sources, + "multi_directional": multi_directional, + } + + sources: MetaOapg.properties.sources + dataset: MetaOapg.properties.dataset + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataset"]) -> MetaOapg.properties.dataset: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sources"]) -> MetaOapg.properties.sources: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["multi_directional"]) -> MetaOapg.properties.multi_directional: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataset", "sources", "multi_directional", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataset"]) -> MetaOapg.properties.dataset: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sources"]) -> MetaOapg.properties.sources: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["multi_directional"]) -> typing.Union[MetaOapg.properties.multi_directional, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataset", "sources", "multi_directional", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + sources: typing.Union[MetaOapg.properties.sources, list, tuple, ], + dataset: typing.Union[MetaOapg.properties.dataset, str, ], + multi_directional: typing.Union[MetaOapg.properties.multi_directional, bool, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacReference': + return super().__new__( + cls, + *_args, + sources=sources, + dataset=dataset, + multi_directional=multi_directional, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_reference_source import AacReferenceSource diff --git a/gooddata-api-client/gooddata_api_client/model/aac_reference_source.pyi b/gooddata-api-client/gooddata_api_client/model/aac_reference_source.pyi new file mode 100644 index 000000000..b349469a4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_reference_source.pyi @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacReferenceSource( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Source columns for the reference. + """ + + + class MetaOapg: + required = { + "source_column", + } + + class properties: + source_column = schemas.StrSchema + + + class data_type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INT(cls): + return cls("INT") + + @schemas.classproperty + def STRING(cls): + return cls("STRING") + + @schemas.classproperty + def DATE(cls): + return cls("DATE") + + @schemas.classproperty + def NUMERIC(cls): + return cls("NUMERIC") + + @schemas.classproperty + def TIMESTAMP(cls): + return cls("TIMESTAMP") + + @schemas.classproperty + def TIMESTAMP_TZ(cls): + return cls("TIMESTAMP_TZ") + + @schemas.classproperty + def BOOLEAN(cls): + return cls("BOOLEAN") + target = schemas.StrSchema + __annotations__ = { + "source_column": source_column, + "data_type": data_type, + "target": target, + } + + source_column: MetaOapg.properties.source_column + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["source_column"]) -> MetaOapg.properties.source_column: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data_type"]) -> MetaOapg.properties.data_type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["target"]) -> MetaOapg.properties.target: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["source_column", "data_type", "target", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["source_column"]) -> MetaOapg.properties.source_column: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data_type"]) -> typing.Union[MetaOapg.properties.data_type, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["target"]) -> typing.Union[MetaOapg.properties.target, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["source_column", "data_type", "target", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + source_column: typing.Union[MetaOapg.properties.source_column, str, ], + data_type: typing.Union[MetaOapg.properties.data_type, str, schemas.Unset] = schemas.unset, + target: typing.Union[MetaOapg.properties.target, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacReferenceSource': + return super().__new__( + cls, + *_args, + source_column=source_column, + data_type=data_type, + target=target, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/aac_rich_text_widget.pyi b/gooddata-api-client/gooddata_api_client/model/aac_rich_text_widget.pyi new file mode 100644 index 000000000..836d0da1d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_rich_text_widget.pyi @@ -0,0 +1,715 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacRichTextWidget( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "content", + } + + class properties: + content = schemas.StrSchema + + + class additionalProperties( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['JsonNode']: + return JsonNode + + def __getitem__(self, name: typing.Union[str, ]) -> 'JsonNode': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'JsonNode': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'JsonNode', + ) -> 'additionalProperties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + columns = schemas.Int32Schema + container = schemas.StrSchema + date = schemas.StrSchema + + + class description( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + + + class one_of_1( + schemas.EnumBase, + schemas.BoolSchema + ): + + @schemas.classproperty + def FALSE(cls): + return cls(False) + + + class one_of_2( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INHERIT(cls): + return cls("inherit") + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'description': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @staticmethod + def drill_down() -> typing.Type['JsonNode']: + return JsonNode + enable_section_headers = schemas.BoolSchema + + + class ignore_dashboard_filters( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ignore_dashboard_filters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class ignored_filters( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ignored_filters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class interactions( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonNode']: + return JsonNode + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonNode'], typing.List['JsonNode']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'interactions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonNode': + return super().__getitem__(i) + layout_direction = schemas.StrSchema + metric = schemas.StrSchema + rows = schemas.Int32Schema + + + class sections( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacSection']: + return AacSection + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacSection'], typing.List['AacSection']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'sections': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacSection': + return super().__getitem__(i) + + @staticmethod + def size() -> typing.Type['AacWidgetSize']: + return AacWidgetSize + + + class title( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + + + class one_of_1( + schemas.EnumBase, + schemas.BoolSchema + ): + + @schemas.classproperty + def FALSE(cls): + return cls(False) + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'title': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + type = schemas.StrSchema + visualization = schemas.StrSchema + + + class visualizations( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacWidget']: + return AacWidget + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacWidget'], typing.List['AacWidget']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visualizations': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacWidget': + return super().__getitem__(i) + zoom_data = schemas.BoolSchema + __annotations__ = { + "content": content, + "additionalProperties": additionalProperties, + "columns": columns, + "container": container, + "date": date, + "description": description, + "drill_down": drill_down, + "enable_section_headers": enable_section_headers, + "ignore_dashboard_filters": ignore_dashboard_filters, + "ignored_filters": ignored_filters, + "interactions": interactions, + "layout_direction": layout_direction, + "metric": metric, + "rows": rows, + "sections": sections, + "size": size, + "title": title, + "type": type, + "visualization": visualization, + "visualizations": visualizations, + "zoom_data": zoom_data, + } + + + class all_of_0( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "visualization", + } + + + visualization: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_1( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "sections", + } + + + sections: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_2( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "visualizations", + } + + + visualizations: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_2': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + cls.all_of_1, + cls.all_of_2, + ] + + + content: MetaOapg.properties.content + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["additionalProperties"]) -> MetaOapg.properties.additionalProperties: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["container"]) -> MetaOapg.properties.container: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["date"]) -> MetaOapg.properties.date: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["drill_down"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["enable_section_headers"]) -> MetaOapg.properties.enable_section_headers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["ignore_dashboard_filters"]) -> MetaOapg.properties.ignore_dashboard_filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["ignored_filters"]) -> MetaOapg.properties.ignored_filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["interactions"]) -> MetaOapg.properties.interactions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["layout_direction"]) -> MetaOapg.properties.layout_direction: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metric"]) -> MetaOapg.properties.metric: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rows"]) -> MetaOapg.properties.rows: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sections"]) -> MetaOapg.properties.sections: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["size"]) -> 'AacWidgetSize': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualization"]) -> MetaOapg.properties.visualization: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualizations"]) -> MetaOapg.properties.visualizations: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["zoom_data"]) -> MetaOapg.properties.zoom_data: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["content", "additionalProperties", "columns", "container", "date", "description", "drill_down", "enable_section_headers", "ignore_dashboard_filters", "ignored_filters", "interactions", "layout_direction", "metric", "rows", "sections", "size", "title", "type", "visualization", "visualizations", "zoom_data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["additionalProperties"]) -> typing.Union[MetaOapg.properties.additionalProperties, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> typing.Union[MetaOapg.properties.columns, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["container"]) -> typing.Union[MetaOapg.properties.container, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["date"]) -> typing.Union[MetaOapg.properties.date, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["drill_down"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["enable_section_headers"]) -> typing.Union[MetaOapg.properties.enable_section_headers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["ignore_dashboard_filters"]) -> typing.Union[MetaOapg.properties.ignore_dashboard_filters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["ignored_filters"]) -> typing.Union[MetaOapg.properties.ignored_filters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["interactions"]) -> typing.Union[MetaOapg.properties.interactions, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["layout_direction"]) -> typing.Union[MetaOapg.properties.layout_direction, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metric"]) -> typing.Union[MetaOapg.properties.metric, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rows"]) -> typing.Union[MetaOapg.properties.rows, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sections"]) -> typing.Union[MetaOapg.properties.sections, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["size"]) -> typing.Union['AacWidgetSize', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> typing.Union[MetaOapg.properties.type, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualization"]) -> typing.Union[MetaOapg.properties.visualization, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualizations"]) -> typing.Union[MetaOapg.properties.visualizations, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["zoom_data"]) -> typing.Union[MetaOapg.properties.zoom_data, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["content", "additionalProperties", "columns", "container", "date", "description", "drill_down", "enable_section_headers", "ignore_dashboard_filters", "ignored_filters", "interactions", "layout_direction", "metric", "rows", "sections", "size", "title", "type", "visualization", "visualizations", "zoom_data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + content: typing.Union[MetaOapg.properties.content, str, ], + additionalProperties: typing.Union[MetaOapg.properties.additionalProperties, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + columns: typing.Union[MetaOapg.properties.columns, decimal.Decimal, int, schemas.Unset] = schemas.unset, + container: typing.Union[MetaOapg.properties.container, str, schemas.Unset] = schemas.unset, + date: typing.Union[MetaOapg.properties.date, str, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + drill_down: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + enable_section_headers: typing.Union[MetaOapg.properties.enable_section_headers, bool, schemas.Unset] = schemas.unset, + ignore_dashboard_filters: typing.Union[MetaOapg.properties.ignore_dashboard_filters, list, tuple, schemas.Unset] = schemas.unset, + ignored_filters: typing.Union[MetaOapg.properties.ignored_filters, list, tuple, schemas.Unset] = schemas.unset, + interactions: typing.Union[MetaOapg.properties.interactions, list, tuple, schemas.Unset] = schemas.unset, + layout_direction: typing.Union[MetaOapg.properties.layout_direction, str, schemas.Unset] = schemas.unset, + metric: typing.Union[MetaOapg.properties.metric, str, schemas.Unset] = schemas.unset, + rows: typing.Union[MetaOapg.properties.rows, decimal.Decimal, int, schemas.Unset] = schemas.unset, + sections: typing.Union[MetaOapg.properties.sections, list, tuple, schemas.Unset] = schemas.unset, + size: typing.Union['AacWidgetSize', schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + type: typing.Union[MetaOapg.properties.type, str, schemas.Unset] = schemas.unset, + visualization: typing.Union[MetaOapg.properties.visualization, str, schemas.Unset] = schemas.unset, + visualizations: typing.Union[MetaOapg.properties.visualizations, list, tuple, schemas.Unset] = schemas.unset, + zoom_data: typing.Union[MetaOapg.properties.zoom_data, bool, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacRichTextWidget': + return super().__new__( + cls, + *_args, + content=content, + additionalProperties=additionalProperties, + columns=columns, + container=container, + date=date, + description=description, + drill_down=drill_down, + enable_section_headers=enable_section_headers, + ignore_dashboard_filters=ignore_dashboard_filters, + ignored_filters=ignored_filters, + interactions=interactions, + layout_direction=layout_direction, + metric=metric, + rows=rows, + sections=sections, + size=size, + title=title, + type=type, + visualization=visualization, + visualizations=visualizations, + zoom_data=zoom_data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_section import AacSection +from gooddata_api_client.model.aac_widget import AacWidget +from gooddata_api_client.model.aac_widget_size import AacWidgetSize +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_section.pyi b/gooddata-api-client/gooddata_api_client/model/aac_section.pyi new file mode 100644 index 000000000..d0fbf34ba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_section.pyi @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacSection( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Sections within the tab. + """ + + + class MetaOapg: + + class properties: + description = schemas.StrSchema + header = schemas.BoolSchema + title = schemas.StrSchema + + + class widgets( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacWidget']: + return AacWidget + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacWidget'], typing.List['AacWidget']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'widgets': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacWidget': + return super().__getitem__(i) + __annotations__ = { + "description": description, + "header": header, + "title": title, + "widgets": widgets, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["header"]) -> MetaOapg.properties.header: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgets"]) -> MetaOapg.properties.widgets: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["description", "header", "title", "widgets", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["header"]) -> typing.Union[MetaOapg.properties.header, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgets"]) -> typing.Union[MetaOapg.properties.widgets, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["description", "header", "title", "widgets", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + header: typing.Union[MetaOapg.properties.header, bool, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + widgets: typing.Union[MetaOapg.properties.widgets, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacSection': + return super().__new__( + cls, + *_args, + description=description, + header=header, + title=title, + widgets=widgets, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_widget import AacWidget diff --git a/gooddata-api-client/gooddata_api_client/model/aac_tab.pyi b/gooddata-api-client/gooddata_api_client/model/aac_tab.pyi new file mode 100644 index 000000000..87bd2781d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_tab.pyi @@ -0,0 +1,177 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacTab( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Dashboard tabs (for tabbed dashboards). + """ + + + class MetaOapg: + required = { + "id", + "title", + } + + class properties: + id = schemas.StrSchema + title = schemas.StrSchema + + + class filters( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['AacDashboardFilter']: + return AacDashboardFilter + + def __getitem__(self, name: typing.Union[str, ]) -> 'AacDashboardFilter': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'AacDashboardFilter': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'AacDashboardFilter', + ) -> 'filters': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class sections( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacSection']: + return AacSection + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacSection'], typing.List['AacSection']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'sections': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacSection': + return super().__getitem__(i) + __annotations__ = { + "id": id, + "title": title, + "filters": filters, + "sections": sections, + } + + id: MetaOapg.properties.id + title: MetaOapg.properties.title + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sections"]) -> MetaOapg.properties.sections: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "title", "filters", "sections", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filters"]) -> typing.Union[MetaOapg.properties.filters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sections"]) -> typing.Union[MetaOapg.properties.sections, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "title", "filters", "sections", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + title: typing.Union[MetaOapg.properties.title, str, ], + filters: typing.Union[MetaOapg.properties.filters, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + sections: typing.Union[MetaOapg.properties.sections, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacTab': + return super().__new__( + cls, + *_args, + id=id, + title=title, + filters=filters, + sections=sections, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_dashboard_filter import AacDashboardFilter +from gooddata_api_client.model.aac_section import AacSection diff --git a/gooddata-api-client/gooddata_api_client/model/aac_visualization.pyi b/gooddata-api-client/gooddata_api_client/model/aac_visualization.pyi new file mode 100644 index 000000000..ffbf1c172 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_visualization.pyi @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacVisualization( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + AAC visualization definition. + """ + + + class MetaOapg: + + @staticmethod + def discriminator(): + return { + 'type': { + 'AacVisualizationBasicBuckets': AacVisualizationBasicBuckets, + 'AacVisualizationBubbleBuckets': AacVisualizationBubbleBuckets, + 'AacVisualizationDependencyBuckets': AacVisualizationDependencyBuckets, + 'AacVisualizationGeoBuckets': AacVisualizationGeoBuckets, + 'AacVisualizationScatterBuckets': AacVisualizationScatterBuckets, + 'AacVisualizationStackedBuckets': AacVisualizationStackedBuckets, + 'AacVisualizationTableBuckets': AacVisualizationTableBuckets, + 'AacVisualizationTrendBuckets': AacVisualizationTrendBuckets, + 'area_chart': AacVisualizationStackedBuckets, + 'bar_chart': AacVisualizationStackedBuckets, + 'bubble_chart': AacVisualizationBubbleBuckets, + 'bullet_chart': AacVisualizationBasicBuckets, + 'column_chart': AacVisualizationStackedBuckets, + 'combo_chart': AacVisualizationBasicBuckets, + 'dependency_wheel_chart': AacVisualizationDependencyBuckets, + 'donut_chart': AacVisualizationBasicBuckets, + 'funnel_chart': AacVisualizationBasicBuckets, + 'geo_area_chart': AacVisualizationGeoBuckets, + 'geo_chart': AacVisualizationGeoBuckets, + 'headline_chart': AacVisualizationBasicBuckets, + 'heatmap_chart': AacVisualizationTableBuckets, + 'line_chart': AacVisualizationTrendBuckets, + 'pie_chart': AacVisualizationBasicBuckets, + 'pyramid_chart': AacVisualizationBasicBuckets, + 'repeater_chart': AacVisualizationTableBuckets, + 'sankey_chart': AacVisualizationDependencyBuckets, + 'scatter_chart': AacVisualizationScatterBuckets, + 'table': AacVisualizationTableBuckets, + 'treemap_chart': AacVisualizationBasicBuckets, + 'waterfall_chart': AacVisualizationBasicBuckets, + } + } + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AacVisualizationTableBuckets, + AacVisualizationStackedBuckets, + AacVisualizationScatterBuckets, + AacVisualizationBubbleBuckets, + AacVisualizationTrendBuckets, + AacVisualizationGeoBuckets, + AacVisualizationBasicBuckets, + AacVisualizationDependencyBuckets, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacVisualization': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_visualization_basic_buckets import AacVisualizationBasicBuckets +from gooddata_api_client.model.aac_visualization_bubble_buckets import AacVisualizationBubbleBuckets +from gooddata_api_client.model.aac_visualization_dependency_buckets import AacVisualizationDependencyBuckets +from gooddata_api_client.model.aac_visualization_geo_buckets import AacVisualizationGeoBuckets +from gooddata_api_client.model.aac_visualization_scatter_buckets import AacVisualizationScatterBuckets +from gooddata_api_client.model.aac_visualization_stacked_buckets import AacVisualizationStackedBuckets +from gooddata_api_client.model.aac_visualization_table_buckets import AacVisualizationTableBuckets +from gooddata_api_client.model.aac_visualization_trend_buckets import AacVisualizationTrendBuckets diff --git a/gooddata-api-client/gooddata_api_client/model/aac_visualization_basic_buckets.pyi b/gooddata-api-client/gooddata_api_client/model/aac_visualization_basic_buckets.pyi new file mode 100644 index 000000000..e124e9829 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_visualization_basic_buckets.pyi @@ -0,0 +1,1453 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacVisualizationBasicBuckets( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "query", + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + @staticmethod + def query() -> typing.Type['AacQuery']: + return AacQuery + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def BULLET_CHART(cls): + return cls("bullet_chart") + + @schemas.classproperty + def COMBO_CHART(cls): + return cls("combo_chart") + + @schemas.classproperty + def DONUT_CHART(cls): + return cls("donut_chart") + + @schemas.classproperty + def FUNNEL_CHART(cls): + return cls("funnel_chart") + + @schemas.classproperty + def HEADLINE_CHART(cls): + return cls("headline_chart") + + @schemas.classproperty + def PIE_CHART(cls): + return cls("pie_chart") + + @schemas.classproperty + def PYRAMID_CHART(cls): + return cls("pyramid_chart") + + @schemas.classproperty + def TREEMAP_CHART(cls): + return cls("treemap_chart") + + @schemas.classproperty + def WATERFALL_CHART(cls): + return cls("waterfall_chart") + + + class additionalProperties( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['JsonNode']: + return JsonNode + + def __getitem__(self, name: typing.Union[str, ]) -> 'JsonNode': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'JsonNode': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'JsonNode', + ) -> 'additionalProperties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class attributes( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attributes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class columns( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'columns': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def config() -> typing.Type['JsonNode']: + return JsonNode + description = schemas.StrSchema + + @staticmethod + def _from() -> typing.Type['JsonNode']: + return JsonNode + is_hidden = schemas.BoolSchema + + + class layers( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacVisualizationLayer']: + return AacVisualizationLayer + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacVisualizationLayer'], typing.List['AacVisualizationLayer']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'layers': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacVisualizationLayer': + return super().__getitem__(i) + + + class metrics( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'metrics': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class rows( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'rows': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class segment_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'segment_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + show_in_ai_results = schemas.BoolSchema + + + class size_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'size_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class stack_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'stack_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + + @staticmethod + def to() -> typing.Type['JsonNode']: + return JsonNode + + + class trend_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'trend_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class view_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'view_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "id": id, + "query": query, + "type": type, + "additionalProperties": additionalProperties, + "attributes": attributes, + "columns": columns, + "config": config, + "description": description, + "from": _from, + "is_hidden": is_hidden, + "layers": layers, + "metrics": metrics, + "rows": rows, + "segment_by": segment_by, + "show_in_ai_results": show_in_ai_results, + "size_by": size_by, + "stack_by": stack_by, + "tags": tags, + "title": title, + "to": to, + "trend_by": trend_by, + "view_by": view_by, + } + + + class all_of_0( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "rows", + } + + + rows: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_1( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "columns", + } + + + columns: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_2( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "from", + } + + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_2': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_3( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "to", + } + + + to: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_3': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_4( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "stack_by", + } + + + stack_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_4': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_5( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "trend_by", + } + + + trend_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_5': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_6( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "size_by", + } + + + size_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_6': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_7( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "attributes", + } + + + attributes: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_7': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_8( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "layers", + } + + + layers: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_8': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + cls.all_of_1, + cls.all_of_2, + cls.all_of_3, + cls.all_of_4, + cls.all_of_5, + cls.all_of_6, + cls.all_of_7, + cls.all_of_8, + ] + + + query: 'AacQuery' + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["query"]) -> 'AacQuery': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["additionalProperties"]) -> MetaOapg.properties.additionalProperties: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["config"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["is_hidden"]) -> MetaOapg.properties.is_hidden: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["layers"]) -> MetaOapg.properties.layers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rows"]) -> MetaOapg.properties.rows: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["segment_by"]) -> MetaOapg.properties.segment_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["show_in_ai_results"]) -> MetaOapg.properties.show_in_ai_results: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["size_by"]) -> MetaOapg.properties.size_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["stack_by"]) -> MetaOapg.properties.stack_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["trend_by"]) -> MetaOapg.properties.trend_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["view_by"]) -> MetaOapg.properties.view_by: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "query", "type", "additionalProperties", "attributes", "columns", "config", "description", "from", "is_hidden", "layers", "metrics", "rows", "segment_by", "show_in_ai_results", "size_by", "stack_by", "tags", "title", "to", "trend_by", "view_by", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["query"]) -> 'AacQuery': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["additionalProperties"]) -> typing.Union[MetaOapg.properties.additionalProperties, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> typing.Union[MetaOapg.properties.columns, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["config"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["is_hidden"]) -> typing.Union[MetaOapg.properties.is_hidden, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["layers"]) -> typing.Union[MetaOapg.properties.layers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rows"]) -> typing.Union[MetaOapg.properties.rows, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["segment_by"]) -> typing.Union[MetaOapg.properties.segment_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["show_in_ai_results"]) -> typing.Union[MetaOapg.properties.show_in_ai_results, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["size_by"]) -> typing.Union[MetaOapg.properties.size_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["stack_by"]) -> typing.Union[MetaOapg.properties.stack_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["trend_by"]) -> typing.Union[MetaOapg.properties.trend_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["view_by"]) -> typing.Union[MetaOapg.properties.view_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "query", "type", "additionalProperties", "attributes", "columns", "config", "description", "from", "is_hidden", "layers", "metrics", "rows", "segment_by", "show_in_ai_results", "size_by", "stack_by", "tags", "title", "to", "trend_by", "view_by", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + query: 'AacQuery', + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + additionalProperties: typing.Union[MetaOapg.properties.additionalProperties, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + attributes: typing.Union[MetaOapg.properties.attributes, list, tuple, schemas.Unset] = schemas.unset, + columns: typing.Union[MetaOapg.properties.columns, list, tuple, schemas.Unset] = schemas.unset, + config: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + is_hidden: typing.Union[MetaOapg.properties.is_hidden, bool, schemas.Unset] = schemas.unset, + layers: typing.Union[MetaOapg.properties.layers, list, tuple, schemas.Unset] = schemas.unset, + metrics: typing.Union[MetaOapg.properties.metrics, list, tuple, schemas.Unset] = schemas.unset, + rows: typing.Union[MetaOapg.properties.rows, list, tuple, schemas.Unset] = schemas.unset, + segment_by: typing.Union[MetaOapg.properties.segment_by, list, tuple, schemas.Unset] = schemas.unset, + show_in_ai_results: typing.Union[MetaOapg.properties.show_in_ai_results, bool, schemas.Unset] = schemas.unset, + size_by: typing.Union[MetaOapg.properties.size_by, list, tuple, schemas.Unset] = schemas.unset, + stack_by: typing.Union[MetaOapg.properties.stack_by, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + to: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + trend_by: typing.Union[MetaOapg.properties.trend_by, list, tuple, schemas.Unset] = schemas.unset, + view_by: typing.Union[MetaOapg.properties.view_by, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacVisualizationBasicBuckets': + return super().__new__( + cls, + *_args, + query=query, + id=id, + type=type, + additionalProperties=additionalProperties, + attributes=attributes, + columns=columns, + config=config, + description=description, + is_hidden=is_hidden, + layers=layers, + metrics=metrics, + rows=rows, + segment_by=segment_by, + show_in_ai_results=show_in_ai_results, + size_by=size_by, + stack_by=stack_by, + tags=tags, + title=title, + to=to, + trend_by=trend_by, + view_by=view_by, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_query import AacQuery +from gooddata_api_client.model.aac_visualization_layer import AacVisualizationLayer +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_visualization_bubble_buckets.pyi b/gooddata-api-client/gooddata_api_client/model/aac_visualization_bubble_buckets.pyi new file mode 100644 index 000000000..28eb8c6bf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_visualization_bubble_buckets.pyi @@ -0,0 +1,1371 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacVisualizationBubbleBuckets( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "query", + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + @staticmethod + def query() -> typing.Type['AacQuery']: + return AacQuery + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def BUBBLE_CHART(cls): + return cls("bubble_chart") + + + class additionalProperties( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['JsonNode']: + return JsonNode + + def __getitem__(self, name: typing.Union[str, ]) -> 'JsonNode': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'JsonNode': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'JsonNode', + ) -> 'additionalProperties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class attributes( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attributes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class columns( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'columns': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def config() -> typing.Type['JsonNode']: + return JsonNode + description = schemas.StrSchema + + @staticmethod + def _from() -> typing.Type['JsonNode']: + return JsonNode + is_hidden = schemas.BoolSchema + + + class layers( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacVisualizationLayer']: + return AacVisualizationLayer + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacVisualizationLayer'], typing.List['AacVisualizationLayer']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'layers': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacVisualizationLayer': + return super().__getitem__(i) + + + class metrics( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'metrics': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class rows( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'rows': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class segment_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'segment_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + show_in_ai_results = schemas.BoolSchema + + + class size_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'size_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class stack_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'stack_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + + @staticmethod + def to() -> typing.Type['JsonNode']: + return JsonNode + + + class trend_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'trend_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class view_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'view_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "id": id, + "query": query, + "type": type, + "additionalProperties": additionalProperties, + "attributes": attributes, + "columns": columns, + "config": config, + "description": description, + "from": _from, + "is_hidden": is_hidden, + "layers": layers, + "metrics": metrics, + "rows": rows, + "segment_by": segment_by, + "show_in_ai_results": show_in_ai_results, + "size_by": size_by, + "stack_by": stack_by, + "tags": tags, + "title": title, + "to": to, + "trend_by": trend_by, + "view_by": view_by, + } + + + class all_of_0( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "rows", + } + + + rows: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_1( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "columns", + } + + + columns: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_2( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "from", + } + + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_2': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_3( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "to", + } + + + to: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_3': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_4( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "stack_by", + } + + + stack_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_4': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_5( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "trend_by", + } + + + trend_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_5': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_6( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "attributes", + } + + + attributes: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_6': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_7( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "layers", + } + + + layers: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_7': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + cls.all_of_1, + cls.all_of_2, + cls.all_of_3, + cls.all_of_4, + cls.all_of_5, + cls.all_of_6, + cls.all_of_7, + ] + + + query: 'AacQuery' + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["query"]) -> 'AacQuery': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["additionalProperties"]) -> MetaOapg.properties.additionalProperties: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["config"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["is_hidden"]) -> MetaOapg.properties.is_hidden: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["layers"]) -> MetaOapg.properties.layers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rows"]) -> MetaOapg.properties.rows: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["segment_by"]) -> MetaOapg.properties.segment_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["show_in_ai_results"]) -> MetaOapg.properties.show_in_ai_results: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["size_by"]) -> MetaOapg.properties.size_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["stack_by"]) -> MetaOapg.properties.stack_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["trend_by"]) -> MetaOapg.properties.trend_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["view_by"]) -> MetaOapg.properties.view_by: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "query", "type", "additionalProperties", "attributes", "columns", "config", "description", "from", "is_hidden", "layers", "metrics", "rows", "segment_by", "show_in_ai_results", "size_by", "stack_by", "tags", "title", "to", "trend_by", "view_by", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["query"]) -> 'AacQuery': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["additionalProperties"]) -> typing.Union[MetaOapg.properties.additionalProperties, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> typing.Union[MetaOapg.properties.columns, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["config"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["is_hidden"]) -> typing.Union[MetaOapg.properties.is_hidden, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["layers"]) -> typing.Union[MetaOapg.properties.layers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rows"]) -> typing.Union[MetaOapg.properties.rows, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["segment_by"]) -> typing.Union[MetaOapg.properties.segment_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["show_in_ai_results"]) -> typing.Union[MetaOapg.properties.show_in_ai_results, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["size_by"]) -> typing.Union[MetaOapg.properties.size_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["stack_by"]) -> typing.Union[MetaOapg.properties.stack_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["trend_by"]) -> typing.Union[MetaOapg.properties.trend_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["view_by"]) -> typing.Union[MetaOapg.properties.view_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "query", "type", "additionalProperties", "attributes", "columns", "config", "description", "from", "is_hidden", "layers", "metrics", "rows", "segment_by", "show_in_ai_results", "size_by", "stack_by", "tags", "title", "to", "trend_by", "view_by", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + query: 'AacQuery', + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + additionalProperties: typing.Union[MetaOapg.properties.additionalProperties, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + attributes: typing.Union[MetaOapg.properties.attributes, list, tuple, schemas.Unset] = schemas.unset, + columns: typing.Union[MetaOapg.properties.columns, list, tuple, schemas.Unset] = schemas.unset, + config: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + is_hidden: typing.Union[MetaOapg.properties.is_hidden, bool, schemas.Unset] = schemas.unset, + layers: typing.Union[MetaOapg.properties.layers, list, tuple, schemas.Unset] = schemas.unset, + metrics: typing.Union[MetaOapg.properties.metrics, list, tuple, schemas.Unset] = schemas.unset, + rows: typing.Union[MetaOapg.properties.rows, list, tuple, schemas.Unset] = schemas.unset, + segment_by: typing.Union[MetaOapg.properties.segment_by, list, tuple, schemas.Unset] = schemas.unset, + show_in_ai_results: typing.Union[MetaOapg.properties.show_in_ai_results, bool, schemas.Unset] = schemas.unset, + size_by: typing.Union[MetaOapg.properties.size_by, list, tuple, schemas.Unset] = schemas.unset, + stack_by: typing.Union[MetaOapg.properties.stack_by, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + to: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + trend_by: typing.Union[MetaOapg.properties.trend_by, list, tuple, schemas.Unset] = schemas.unset, + view_by: typing.Union[MetaOapg.properties.view_by, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacVisualizationBubbleBuckets': + return super().__new__( + cls, + *_args, + query=query, + id=id, + type=type, + additionalProperties=additionalProperties, + attributes=attributes, + columns=columns, + config=config, + description=description, + is_hidden=is_hidden, + layers=layers, + metrics=metrics, + rows=rows, + segment_by=segment_by, + show_in_ai_results=show_in_ai_results, + size_by=size_by, + stack_by=stack_by, + tags=tags, + title=title, + to=to, + trend_by=trend_by, + view_by=view_by, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_query import AacQuery +from gooddata_api_client.model.aac_visualization_layer import AacVisualizationLayer +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_visualization_dependency_buckets.pyi b/gooddata-api-client/gooddata_api_client/model/aac_visualization_dependency_buckets.pyi new file mode 100644 index 000000000..ee0c36f36 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_visualization_dependency_buckets.pyi @@ -0,0 +1,1326 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacVisualizationDependencyBuckets( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "query", + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + @staticmethod + def query() -> typing.Type['AacQuery']: + return AacQuery + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DEPENDENCY_WHEEL_CHART(cls): + return cls("dependency_wheel_chart") + + @schemas.classproperty + def SANKEY_CHART(cls): + return cls("sankey_chart") + + + class additionalProperties( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['JsonNode']: + return JsonNode + + def __getitem__(self, name: typing.Union[str, ]) -> 'JsonNode': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'JsonNode': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'JsonNode', + ) -> 'additionalProperties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class attributes( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attributes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class columns( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'columns': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def config() -> typing.Type['JsonNode']: + return JsonNode + description = schemas.StrSchema + + @staticmethod + def _from() -> typing.Type['JsonNode']: + return JsonNode + is_hidden = schemas.BoolSchema + + + class layers( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacVisualizationLayer']: + return AacVisualizationLayer + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacVisualizationLayer'], typing.List['AacVisualizationLayer']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'layers': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacVisualizationLayer': + return super().__getitem__(i) + + + class metrics( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'metrics': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class rows( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'rows': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class segment_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'segment_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + show_in_ai_results = schemas.BoolSchema + + + class size_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'size_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class stack_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'stack_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + + @staticmethod + def to() -> typing.Type['JsonNode']: + return JsonNode + + + class trend_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'trend_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class view_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'view_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "id": id, + "query": query, + "type": type, + "additionalProperties": additionalProperties, + "attributes": attributes, + "columns": columns, + "config": config, + "description": description, + "from": _from, + "is_hidden": is_hidden, + "layers": layers, + "metrics": metrics, + "rows": rows, + "segment_by": segment_by, + "show_in_ai_results": show_in_ai_results, + "size_by": size_by, + "stack_by": stack_by, + "tags": tags, + "title": title, + "to": to, + "trend_by": trend_by, + "view_by": view_by, + } + + + class all_of_0( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "rows", + } + + + rows: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_1( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "columns", + } + + + columns: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_2( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "stack_by", + } + + + stack_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_2': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_3( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "trend_by", + } + + + trend_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_3': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_4( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "size_by", + } + + + size_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_4': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_5( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "attributes", + } + + + attributes: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_5': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_6( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "layers", + } + + + layers: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_6': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + cls.all_of_1, + cls.all_of_2, + cls.all_of_3, + cls.all_of_4, + cls.all_of_5, + cls.all_of_6, + ] + + + query: 'AacQuery' + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["query"]) -> 'AacQuery': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["additionalProperties"]) -> MetaOapg.properties.additionalProperties: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["config"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["is_hidden"]) -> MetaOapg.properties.is_hidden: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["layers"]) -> MetaOapg.properties.layers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rows"]) -> MetaOapg.properties.rows: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["segment_by"]) -> MetaOapg.properties.segment_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["show_in_ai_results"]) -> MetaOapg.properties.show_in_ai_results: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["size_by"]) -> MetaOapg.properties.size_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["stack_by"]) -> MetaOapg.properties.stack_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["trend_by"]) -> MetaOapg.properties.trend_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["view_by"]) -> MetaOapg.properties.view_by: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "query", "type", "additionalProperties", "attributes", "columns", "config", "description", "from", "is_hidden", "layers", "metrics", "rows", "segment_by", "show_in_ai_results", "size_by", "stack_by", "tags", "title", "to", "trend_by", "view_by", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["query"]) -> 'AacQuery': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["additionalProperties"]) -> typing.Union[MetaOapg.properties.additionalProperties, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> typing.Union[MetaOapg.properties.columns, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["config"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["is_hidden"]) -> typing.Union[MetaOapg.properties.is_hidden, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["layers"]) -> typing.Union[MetaOapg.properties.layers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rows"]) -> typing.Union[MetaOapg.properties.rows, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["segment_by"]) -> typing.Union[MetaOapg.properties.segment_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["show_in_ai_results"]) -> typing.Union[MetaOapg.properties.show_in_ai_results, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["size_by"]) -> typing.Union[MetaOapg.properties.size_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["stack_by"]) -> typing.Union[MetaOapg.properties.stack_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["trend_by"]) -> typing.Union[MetaOapg.properties.trend_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["view_by"]) -> typing.Union[MetaOapg.properties.view_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "query", "type", "additionalProperties", "attributes", "columns", "config", "description", "from", "is_hidden", "layers", "metrics", "rows", "segment_by", "show_in_ai_results", "size_by", "stack_by", "tags", "title", "to", "trend_by", "view_by", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + query: 'AacQuery', + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + additionalProperties: typing.Union[MetaOapg.properties.additionalProperties, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + attributes: typing.Union[MetaOapg.properties.attributes, list, tuple, schemas.Unset] = schemas.unset, + columns: typing.Union[MetaOapg.properties.columns, list, tuple, schemas.Unset] = schemas.unset, + config: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + is_hidden: typing.Union[MetaOapg.properties.is_hidden, bool, schemas.Unset] = schemas.unset, + layers: typing.Union[MetaOapg.properties.layers, list, tuple, schemas.Unset] = schemas.unset, + metrics: typing.Union[MetaOapg.properties.metrics, list, tuple, schemas.Unset] = schemas.unset, + rows: typing.Union[MetaOapg.properties.rows, list, tuple, schemas.Unset] = schemas.unset, + segment_by: typing.Union[MetaOapg.properties.segment_by, list, tuple, schemas.Unset] = schemas.unset, + show_in_ai_results: typing.Union[MetaOapg.properties.show_in_ai_results, bool, schemas.Unset] = schemas.unset, + size_by: typing.Union[MetaOapg.properties.size_by, list, tuple, schemas.Unset] = schemas.unset, + stack_by: typing.Union[MetaOapg.properties.stack_by, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + to: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + trend_by: typing.Union[MetaOapg.properties.trend_by, list, tuple, schemas.Unset] = schemas.unset, + view_by: typing.Union[MetaOapg.properties.view_by, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacVisualizationDependencyBuckets': + return super().__new__( + cls, + *_args, + query=query, + id=id, + type=type, + additionalProperties=additionalProperties, + attributes=attributes, + columns=columns, + config=config, + description=description, + is_hidden=is_hidden, + layers=layers, + metrics=metrics, + rows=rows, + segment_by=segment_by, + show_in_ai_results=show_in_ai_results, + size_by=size_by, + stack_by=stack_by, + tags=tags, + title=title, + to=to, + trend_by=trend_by, + view_by=view_by, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_query import AacQuery +from gooddata_api_client.model.aac_visualization_layer import AacVisualizationLayer +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_visualization_geo_buckets.pyi b/gooddata-api-client/gooddata_api_client/model/aac_visualization_geo_buckets.pyi new file mode 100644 index 000000000..ca14df454 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_visualization_geo_buckets.pyi @@ -0,0 +1,1375 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacVisualizationGeoBuckets( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "query", + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + @staticmethod + def query() -> typing.Type['AacQuery']: + return AacQuery + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def CHART(cls): + return cls("geo_chart") + + @schemas.classproperty + def AREA_CHART(cls): + return cls("geo_area_chart") + + + class additionalProperties( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['JsonNode']: + return JsonNode + + def __getitem__(self, name: typing.Union[str, ]) -> 'JsonNode': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'JsonNode': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'JsonNode', + ) -> 'additionalProperties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class attributes( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attributes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class columns( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'columns': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def config() -> typing.Type['JsonNode']: + return JsonNode + description = schemas.StrSchema + + @staticmethod + def _from() -> typing.Type['JsonNode']: + return JsonNode + is_hidden = schemas.BoolSchema + + + class layers( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacVisualizationLayer']: + return AacVisualizationLayer + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacVisualizationLayer'], typing.List['AacVisualizationLayer']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'layers': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacVisualizationLayer': + return super().__getitem__(i) + + + class metrics( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'metrics': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class rows( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'rows': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class segment_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'segment_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + show_in_ai_results = schemas.BoolSchema + + + class size_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'size_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class stack_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'stack_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + + @staticmethod + def to() -> typing.Type['JsonNode']: + return JsonNode + + + class trend_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'trend_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class view_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'view_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "id": id, + "query": query, + "type": type, + "additionalProperties": additionalProperties, + "attributes": attributes, + "columns": columns, + "config": config, + "description": description, + "from": _from, + "is_hidden": is_hidden, + "layers": layers, + "metrics": metrics, + "rows": rows, + "segment_by": segment_by, + "show_in_ai_results": show_in_ai_results, + "size_by": size_by, + "stack_by": stack_by, + "tags": tags, + "title": title, + "to": to, + "trend_by": trend_by, + "view_by": view_by, + } + + + class all_of_0( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "rows", + } + + + rows: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_1( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "columns", + } + + + columns: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_2( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "from", + } + + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_2': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_3( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "to", + } + + + to: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_3': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_4( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "stack_by", + } + + + stack_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_4': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_5( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "trend_by", + } + + + trend_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_5': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_6( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "size_by", + } + + + size_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_6': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_7( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "attributes", + } + + + attributes: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_7': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + cls.all_of_1, + cls.all_of_2, + cls.all_of_3, + cls.all_of_4, + cls.all_of_5, + cls.all_of_6, + cls.all_of_7, + ] + + + query: 'AacQuery' + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["query"]) -> 'AacQuery': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["additionalProperties"]) -> MetaOapg.properties.additionalProperties: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["config"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["is_hidden"]) -> MetaOapg.properties.is_hidden: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["layers"]) -> MetaOapg.properties.layers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rows"]) -> MetaOapg.properties.rows: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["segment_by"]) -> MetaOapg.properties.segment_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["show_in_ai_results"]) -> MetaOapg.properties.show_in_ai_results: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["size_by"]) -> MetaOapg.properties.size_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["stack_by"]) -> MetaOapg.properties.stack_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["trend_by"]) -> MetaOapg.properties.trend_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["view_by"]) -> MetaOapg.properties.view_by: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "query", "type", "additionalProperties", "attributes", "columns", "config", "description", "from", "is_hidden", "layers", "metrics", "rows", "segment_by", "show_in_ai_results", "size_by", "stack_by", "tags", "title", "to", "trend_by", "view_by", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["query"]) -> 'AacQuery': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["additionalProperties"]) -> typing.Union[MetaOapg.properties.additionalProperties, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> typing.Union[MetaOapg.properties.columns, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["config"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["is_hidden"]) -> typing.Union[MetaOapg.properties.is_hidden, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["layers"]) -> typing.Union[MetaOapg.properties.layers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rows"]) -> typing.Union[MetaOapg.properties.rows, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["segment_by"]) -> typing.Union[MetaOapg.properties.segment_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["show_in_ai_results"]) -> typing.Union[MetaOapg.properties.show_in_ai_results, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["size_by"]) -> typing.Union[MetaOapg.properties.size_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["stack_by"]) -> typing.Union[MetaOapg.properties.stack_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["trend_by"]) -> typing.Union[MetaOapg.properties.trend_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["view_by"]) -> typing.Union[MetaOapg.properties.view_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "query", "type", "additionalProperties", "attributes", "columns", "config", "description", "from", "is_hidden", "layers", "metrics", "rows", "segment_by", "show_in_ai_results", "size_by", "stack_by", "tags", "title", "to", "trend_by", "view_by", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + query: 'AacQuery', + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + additionalProperties: typing.Union[MetaOapg.properties.additionalProperties, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + attributes: typing.Union[MetaOapg.properties.attributes, list, tuple, schemas.Unset] = schemas.unset, + columns: typing.Union[MetaOapg.properties.columns, list, tuple, schemas.Unset] = schemas.unset, + config: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + is_hidden: typing.Union[MetaOapg.properties.is_hidden, bool, schemas.Unset] = schemas.unset, + layers: typing.Union[MetaOapg.properties.layers, list, tuple, schemas.Unset] = schemas.unset, + metrics: typing.Union[MetaOapg.properties.metrics, list, tuple, schemas.Unset] = schemas.unset, + rows: typing.Union[MetaOapg.properties.rows, list, tuple, schemas.Unset] = schemas.unset, + segment_by: typing.Union[MetaOapg.properties.segment_by, list, tuple, schemas.Unset] = schemas.unset, + show_in_ai_results: typing.Union[MetaOapg.properties.show_in_ai_results, bool, schemas.Unset] = schemas.unset, + size_by: typing.Union[MetaOapg.properties.size_by, list, tuple, schemas.Unset] = schemas.unset, + stack_by: typing.Union[MetaOapg.properties.stack_by, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + to: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + trend_by: typing.Union[MetaOapg.properties.trend_by, list, tuple, schemas.Unset] = schemas.unset, + view_by: typing.Union[MetaOapg.properties.view_by, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacVisualizationGeoBuckets': + return super().__new__( + cls, + *_args, + query=query, + id=id, + type=type, + additionalProperties=additionalProperties, + attributes=attributes, + columns=columns, + config=config, + description=description, + is_hidden=is_hidden, + layers=layers, + metrics=metrics, + rows=rows, + segment_by=segment_by, + show_in_ai_results=show_in_ai_results, + size_by=size_by, + stack_by=stack_by, + tags=tags, + title=title, + to=to, + trend_by=trend_by, + view_by=view_by, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_query import AacQuery +from gooddata_api_client.model.aac_visualization_layer import AacVisualizationLayer +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_visualization_layer.pyi b/gooddata-api-client/gooddata_api_client/model/aac_visualization_layer.pyi new file mode 100644 index 000000000..7a9091087 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_visualization_layer.pyi @@ -0,0 +1,455 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacVisualizationLayer( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Visualization data layers (for geo charts). + """ + + + class MetaOapg: + required = { + "id", + } + + class properties: + id = schemas.StrSchema + + + class additionalProperties( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['JsonNode']: + return JsonNode + + def __getitem__(self, name: typing.Union[str, ]) -> 'JsonNode': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'JsonNode': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'JsonNode', + ) -> 'additionalProperties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @staticmethod + def config() -> typing.Type['JsonNode']: + return JsonNode + + + class filters( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['AacQueryFilter']: + return AacQueryFilter + + def __getitem__(self, name: typing.Union[str, ]) -> 'AacQueryFilter': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'AacQueryFilter': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'AacQueryFilter', + ) -> 'filters': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class metrics( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'metrics': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class segment_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'segment_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class sorts( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonNode']: + return JsonNode + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonNode'], typing.List['JsonNode']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'sorts': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonNode': + return super().__getitem__(i) + title = schemas.StrSchema + type = schemas.StrSchema + + + class view_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'view_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "id": id, + "additionalProperties": additionalProperties, + "config": config, + "filters": filters, + "metrics": metrics, + "segment_by": segment_by, + "sorts": sorts, + "title": title, + "type": type, + "view_by": view_by, + } + + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["additionalProperties"]) -> MetaOapg.properties.additionalProperties: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["config"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["segment_by"]) -> MetaOapg.properties.segment_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sorts"]) -> MetaOapg.properties.sorts: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["view_by"]) -> MetaOapg.properties.view_by: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "additionalProperties", "config", "filters", "metrics", "segment_by", "sorts", "title", "type", "view_by", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["additionalProperties"]) -> typing.Union[MetaOapg.properties.additionalProperties, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["config"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filters"]) -> typing.Union[MetaOapg.properties.filters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["segment_by"]) -> typing.Union[MetaOapg.properties.segment_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sorts"]) -> typing.Union[MetaOapg.properties.sorts, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> typing.Union[MetaOapg.properties.type, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["view_by"]) -> typing.Union[MetaOapg.properties.view_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "additionalProperties", "config", "filters", "metrics", "segment_by", "sorts", "title", "type", "view_by", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + additionalProperties: typing.Union[MetaOapg.properties.additionalProperties, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + config: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + filters: typing.Union[MetaOapg.properties.filters, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + metrics: typing.Union[MetaOapg.properties.metrics, list, tuple, schemas.Unset] = schemas.unset, + segment_by: typing.Union[MetaOapg.properties.segment_by, list, tuple, schemas.Unset] = schemas.unset, + sorts: typing.Union[MetaOapg.properties.sorts, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + type: typing.Union[MetaOapg.properties.type, str, schemas.Unset] = schemas.unset, + view_by: typing.Union[MetaOapg.properties.view_by, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacVisualizationLayer': + return super().__new__( + cls, + *_args, + id=id, + additionalProperties=additionalProperties, + config=config, + filters=filters, + metrics=metrics, + segment_by=segment_by, + sorts=sorts, + title=title, + type=type, + view_by=view_by, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_query_filter import AacQueryFilter +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_visualization_scatter_buckets.pyi b/gooddata-api-client/gooddata_api_client/model/aac_visualization_scatter_buckets.pyi new file mode 100644 index 000000000..6ea52b6d7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_visualization_scatter_buckets.pyi @@ -0,0 +1,1371 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacVisualizationScatterBuckets( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "query", + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + @staticmethod + def query() -> typing.Type['AacQuery']: + return AacQuery + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SCATTER_CHART(cls): + return cls("scatter_chart") + + + class additionalProperties( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['JsonNode']: + return JsonNode + + def __getitem__(self, name: typing.Union[str, ]) -> 'JsonNode': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'JsonNode': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'JsonNode', + ) -> 'additionalProperties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class attributes( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attributes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class columns( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'columns': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def config() -> typing.Type['JsonNode']: + return JsonNode + description = schemas.StrSchema + + @staticmethod + def _from() -> typing.Type['JsonNode']: + return JsonNode + is_hidden = schemas.BoolSchema + + + class layers( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacVisualizationLayer']: + return AacVisualizationLayer + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacVisualizationLayer'], typing.List['AacVisualizationLayer']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'layers': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacVisualizationLayer': + return super().__getitem__(i) + + + class metrics( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'metrics': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class rows( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'rows': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class segment_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'segment_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + show_in_ai_results = schemas.BoolSchema + + + class size_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'size_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class stack_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'stack_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + + @staticmethod + def to() -> typing.Type['JsonNode']: + return JsonNode + + + class trend_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'trend_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class view_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'view_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "id": id, + "query": query, + "type": type, + "additionalProperties": additionalProperties, + "attributes": attributes, + "columns": columns, + "config": config, + "description": description, + "from": _from, + "is_hidden": is_hidden, + "layers": layers, + "metrics": metrics, + "rows": rows, + "segment_by": segment_by, + "show_in_ai_results": show_in_ai_results, + "size_by": size_by, + "stack_by": stack_by, + "tags": tags, + "title": title, + "to": to, + "trend_by": trend_by, + "view_by": view_by, + } + + + class all_of_0( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "rows", + } + + + rows: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_1( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "columns", + } + + + columns: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_2( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "from", + } + + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_2': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_3( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "to", + } + + + to: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_3': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_4( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "stack_by", + } + + + stack_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_4': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_5( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "trend_by", + } + + + trend_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_5': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_6( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "size_by", + } + + + size_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_6': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_7( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "layers", + } + + + layers: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_7': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + cls.all_of_1, + cls.all_of_2, + cls.all_of_3, + cls.all_of_4, + cls.all_of_5, + cls.all_of_6, + cls.all_of_7, + ] + + + query: 'AacQuery' + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["query"]) -> 'AacQuery': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["additionalProperties"]) -> MetaOapg.properties.additionalProperties: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["config"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["is_hidden"]) -> MetaOapg.properties.is_hidden: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["layers"]) -> MetaOapg.properties.layers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rows"]) -> MetaOapg.properties.rows: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["segment_by"]) -> MetaOapg.properties.segment_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["show_in_ai_results"]) -> MetaOapg.properties.show_in_ai_results: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["size_by"]) -> MetaOapg.properties.size_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["stack_by"]) -> MetaOapg.properties.stack_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["trend_by"]) -> MetaOapg.properties.trend_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["view_by"]) -> MetaOapg.properties.view_by: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "query", "type", "additionalProperties", "attributes", "columns", "config", "description", "from", "is_hidden", "layers", "metrics", "rows", "segment_by", "show_in_ai_results", "size_by", "stack_by", "tags", "title", "to", "trend_by", "view_by", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["query"]) -> 'AacQuery': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["additionalProperties"]) -> typing.Union[MetaOapg.properties.additionalProperties, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> typing.Union[MetaOapg.properties.columns, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["config"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["is_hidden"]) -> typing.Union[MetaOapg.properties.is_hidden, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["layers"]) -> typing.Union[MetaOapg.properties.layers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rows"]) -> typing.Union[MetaOapg.properties.rows, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["segment_by"]) -> typing.Union[MetaOapg.properties.segment_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["show_in_ai_results"]) -> typing.Union[MetaOapg.properties.show_in_ai_results, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["size_by"]) -> typing.Union[MetaOapg.properties.size_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["stack_by"]) -> typing.Union[MetaOapg.properties.stack_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["trend_by"]) -> typing.Union[MetaOapg.properties.trend_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["view_by"]) -> typing.Union[MetaOapg.properties.view_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "query", "type", "additionalProperties", "attributes", "columns", "config", "description", "from", "is_hidden", "layers", "metrics", "rows", "segment_by", "show_in_ai_results", "size_by", "stack_by", "tags", "title", "to", "trend_by", "view_by", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + query: 'AacQuery', + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + additionalProperties: typing.Union[MetaOapg.properties.additionalProperties, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + attributes: typing.Union[MetaOapg.properties.attributes, list, tuple, schemas.Unset] = schemas.unset, + columns: typing.Union[MetaOapg.properties.columns, list, tuple, schemas.Unset] = schemas.unset, + config: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + is_hidden: typing.Union[MetaOapg.properties.is_hidden, bool, schemas.Unset] = schemas.unset, + layers: typing.Union[MetaOapg.properties.layers, list, tuple, schemas.Unset] = schemas.unset, + metrics: typing.Union[MetaOapg.properties.metrics, list, tuple, schemas.Unset] = schemas.unset, + rows: typing.Union[MetaOapg.properties.rows, list, tuple, schemas.Unset] = schemas.unset, + segment_by: typing.Union[MetaOapg.properties.segment_by, list, tuple, schemas.Unset] = schemas.unset, + show_in_ai_results: typing.Union[MetaOapg.properties.show_in_ai_results, bool, schemas.Unset] = schemas.unset, + size_by: typing.Union[MetaOapg.properties.size_by, list, tuple, schemas.Unset] = schemas.unset, + stack_by: typing.Union[MetaOapg.properties.stack_by, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + to: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + trend_by: typing.Union[MetaOapg.properties.trend_by, list, tuple, schemas.Unset] = schemas.unset, + view_by: typing.Union[MetaOapg.properties.view_by, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacVisualizationScatterBuckets': + return super().__new__( + cls, + *_args, + query=query, + id=id, + type=type, + additionalProperties=additionalProperties, + attributes=attributes, + columns=columns, + config=config, + description=description, + is_hidden=is_hidden, + layers=layers, + metrics=metrics, + rows=rows, + segment_by=segment_by, + show_in_ai_results=show_in_ai_results, + size_by=size_by, + stack_by=stack_by, + tags=tags, + title=title, + to=to, + trend_by=trend_by, + view_by=view_by, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_query import AacQuery +from gooddata_api_client.model.aac_visualization_layer import AacVisualizationLayer +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_visualization_stacked_buckets.pyi b/gooddata-api-client/gooddata_api_client/model/aac_visualization_stacked_buckets.pyi new file mode 100644 index 000000000..8956c66d6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_visualization_stacked_buckets.pyi @@ -0,0 +1,1379 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacVisualizationStackedBuckets( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "query", + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + @staticmethod + def query() -> typing.Type['AacQuery']: + return AacQuery + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def BAR_CHART(cls): + return cls("bar_chart") + + @schemas.classproperty + def COLUMN_CHART(cls): + return cls("column_chart") + + @schemas.classproperty + def AREA_CHART(cls): + return cls("area_chart") + + + class additionalProperties( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['JsonNode']: + return JsonNode + + def __getitem__(self, name: typing.Union[str, ]) -> 'JsonNode': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'JsonNode': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'JsonNode', + ) -> 'additionalProperties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class attributes( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attributes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class columns( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'columns': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def config() -> typing.Type['JsonNode']: + return JsonNode + description = schemas.StrSchema + + @staticmethod + def _from() -> typing.Type['JsonNode']: + return JsonNode + is_hidden = schemas.BoolSchema + + + class layers( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacVisualizationLayer']: + return AacVisualizationLayer + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacVisualizationLayer'], typing.List['AacVisualizationLayer']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'layers': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacVisualizationLayer': + return super().__getitem__(i) + + + class metrics( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'metrics': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class rows( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'rows': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class segment_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'segment_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + show_in_ai_results = schemas.BoolSchema + + + class size_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'size_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class stack_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'stack_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + + @staticmethod + def to() -> typing.Type['JsonNode']: + return JsonNode + + + class trend_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'trend_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class view_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'view_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "id": id, + "query": query, + "type": type, + "additionalProperties": additionalProperties, + "attributes": attributes, + "columns": columns, + "config": config, + "description": description, + "from": _from, + "is_hidden": is_hidden, + "layers": layers, + "metrics": metrics, + "rows": rows, + "segment_by": segment_by, + "show_in_ai_results": show_in_ai_results, + "size_by": size_by, + "stack_by": stack_by, + "tags": tags, + "title": title, + "to": to, + "trend_by": trend_by, + "view_by": view_by, + } + + + class all_of_0( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "rows", + } + + + rows: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_1( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "columns", + } + + + columns: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_2( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "from", + } + + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_2': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_3( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "to", + } + + + to: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_3': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_4( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "trend_by", + } + + + trend_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_4': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_5( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "size_by", + } + + + size_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_5': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_6( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "attributes", + } + + + attributes: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_6': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_7( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "layers", + } + + + layers: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_7': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + cls.all_of_1, + cls.all_of_2, + cls.all_of_3, + cls.all_of_4, + cls.all_of_5, + cls.all_of_6, + cls.all_of_7, + ] + + + query: 'AacQuery' + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["query"]) -> 'AacQuery': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["additionalProperties"]) -> MetaOapg.properties.additionalProperties: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["config"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["is_hidden"]) -> MetaOapg.properties.is_hidden: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["layers"]) -> MetaOapg.properties.layers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rows"]) -> MetaOapg.properties.rows: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["segment_by"]) -> MetaOapg.properties.segment_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["show_in_ai_results"]) -> MetaOapg.properties.show_in_ai_results: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["size_by"]) -> MetaOapg.properties.size_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["stack_by"]) -> MetaOapg.properties.stack_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["trend_by"]) -> MetaOapg.properties.trend_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["view_by"]) -> MetaOapg.properties.view_by: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "query", "type", "additionalProperties", "attributes", "columns", "config", "description", "from", "is_hidden", "layers", "metrics", "rows", "segment_by", "show_in_ai_results", "size_by", "stack_by", "tags", "title", "to", "trend_by", "view_by", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["query"]) -> 'AacQuery': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["additionalProperties"]) -> typing.Union[MetaOapg.properties.additionalProperties, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> typing.Union[MetaOapg.properties.columns, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["config"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["is_hidden"]) -> typing.Union[MetaOapg.properties.is_hidden, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["layers"]) -> typing.Union[MetaOapg.properties.layers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rows"]) -> typing.Union[MetaOapg.properties.rows, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["segment_by"]) -> typing.Union[MetaOapg.properties.segment_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["show_in_ai_results"]) -> typing.Union[MetaOapg.properties.show_in_ai_results, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["size_by"]) -> typing.Union[MetaOapg.properties.size_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["stack_by"]) -> typing.Union[MetaOapg.properties.stack_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["trend_by"]) -> typing.Union[MetaOapg.properties.trend_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["view_by"]) -> typing.Union[MetaOapg.properties.view_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "query", "type", "additionalProperties", "attributes", "columns", "config", "description", "from", "is_hidden", "layers", "metrics", "rows", "segment_by", "show_in_ai_results", "size_by", "stack_by", "tags", "title", "to", "trend_by", "view_by", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + query: 'AacQuery', + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + additionalProperties: typing.Union[MetaOapg.properties.additionalProperties, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + attributes: typing.Union[MetaOapg.properties.attributes, list, tuple, schemas.Unset] = schemas.unset, + columns: typing.Union[MetaOapg.properties.columns, list, tuple, schemas.Unset] = schemas.unset, + config: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + is_hidden: typing.Union[MetaOapg.properties.is_hidden, bool, schemas.Unset] = schemas.unset, + layers: typing.Union[MetaOapg.properties.layers, list, tuple, schemas.Unset] = schemas.unset, + metrics: typing.Union[MetaOapg.properties.metrics, list, tuple, schemas.Unset] = schemas.unset, + rows: typing.Union[MetaOapg.properties.rows, list, tuple, schemas.Unset] = schemas.unset, + segment_by: typing.Union[MetaOapg.properties.segment_by, list, tuple, schemas.Unset] = schemas.unset, + show_in_ai_results: typing.Union[MetaOapg.properties.show_in_ai_results, bool, schemas.Unset] = schemas.unset, + size_by: typing.Union[MetaOapg.properties.size_by, list, tuple, schemas.Unset] = schemas.unset, + stack_by: typing.Union[MetaOapg.properties.stack_by, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + to: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + trend_by: typing.Union[MetaOapg.properties.trend_by, list, tuple, schemas.Unset] = schemas.unset, + view_by: typing.Union[MetaOapg.properties.view_by, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacVisualizationStackedBuckets': + return super().__new__( + cls, + *_args, + query=query, + id=id, + type=type, + additionalProperties=additionalProperties, + attributes=attributes, + columns=columns, + config=config, + description=description, + is_hidden=is_hidden, + layers=layers, + metrics=metrics, + rows=rows, + segment_by=segment_by, + show_in_ai_results=show_in_ai_results, + size_by=size_by, + stack_by=stack_by, + tags=tags, + title=title, + to=to, + trend_by=trend_by, + view_by=view_by, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_query import AacQuery +from gooddata_api_client.model.aac_visualization_layer import AacVisualizationLayer +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_visualization_switcher_widget.pyi b/gooddata-api-client/gooddata_api_client/model/aac_visualization_switcher_widget.pyi new file mode 100644 index 000000000..be124925a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_visualization_switcher_widget.pyi @@ -0,0 +1,715 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacVisualizationSwitcherWidget( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "visualizations", + } + + class properties: + + + class visualizations( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacVisualizationWidget']: + return AacVisualizationWidget + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacVisualizationWidget'], typing.List['AacVisualizationWidget']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visualizations': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacVisualizationWidget': + return super().__getitem__(i) + + + class additionalProperties( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['JsonNode']: + return JsonNode + + def __getitem__(self, name: typing.Union[str, ]) -> 'JsonNode': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'JsonNode': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'JsonNode', + ) -> 'additionalProperties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + columns = schemas.Int32Schema + container = schemas.StrSchema + content = schemas.StrSchema + date = schemas.StrSchema + + + class description( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + + + class one_of_1( + schemas.EnumBase, + schemas.BoolSchema + ): + + @schemas.classproperty + def FALSE(cls): + return cls(False) + + + class one_of_2( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INHERIT(cls): + return cls("inherit") + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'description': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @staticmethod + def drill_down() -> typing.Type['JsonNode']: + return JsonNode + enable_section_headers = schemas.BoolSchema + + + class ignore_dashboard_filters( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ignore_dashboard_filters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class ignored_filters( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ignored_filters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class interactions( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonNode']: + return JsonNode + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonNode'], typing.List['JsonNode']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'interactions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonNode': + return super().__getitem__(i) + layout_direction = schemas.StrSchema + metric = schemas.StrSchema + rows = schemas.Int32Schema + + + class sections( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacSection']: + return AacSection + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacSection'], typing.List['AacSection']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'sections': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacSection': + return super().__getitem__(i) + + @staticmethod + def size() -> typing.Type['AacWidgetSize']: + return AacWidgetSize + + + class title( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + + + class one_of_1( + schemas.EnumBase, + schemas.BoolSchema + ): + + @schemas.classproperty + def FALSE(cls): + return cls(False) + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'title': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + type = schemas.StrSchema + visualization = schemas.StrSchema + zoom_data = schemas.BoolSchema + __annotations__ = { + "visualizations": visualizations, + "additionalProperties": additionalProperties, + "columns": columns, + "container": container, + "content": content, + "date": date, + "description": description, + "drill_down": drill_down, + "enable_section_headers": enable_section_headers, + "ignore_dashboard_filters": ignore_dashboard_filters, + "ignored_filters": ignored_filters, + "interactions": interactions, + "layout_direction": layout_direction, + "metric": metric, + "rows": rows, + "sections": sections, + "size": size, + "title": title, + "type": type, + "visualization": visualization, + "zoom_data": zoom_data, + } + + + class all_of_0( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "visualization", + } + + + visualization: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_1( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "content", + } + + + content: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_2( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "sections", + } + + + sections: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_2': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + cls.all_of_1, + cls.all_of_2, + ] + + + visualizations: MetaOapg.properties.visualizations + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualizations"]) -> MetaOapg.properties.visualizations: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["additionalProperties"]) -> MetaOapg.properties.additionalProperties: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["container"]) -> MetaOapg.properties.container: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["date"]) -> MetaOapg.properties.date: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["drill_down"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["enable_section_headers"]) -> MetaOapg.properties.enable_section_headers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["ignore_dashboard_filters"]) -> MetaOapg.properties.ignore_dashboard_filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["ignored_filters"]) -> MetaOapg.properties.ignored_filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["interactions"]) -> MetaOapg.properties.interactions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["layout_direction"]) -> MetaOapg.properties.layout_direction: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metric"]) -> MetaOapg.properties.metric: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rows"]) -> MetaOapg.properties.rows: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sections"]) -> MetaOapg.properties.sections: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["size"]) -> 'AacWidgetSize': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualization"]) -> MetaOapg.properties.visualization: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["zoom_data"]) -> MetaOapg.properties.zoom_data: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["visualizations", "additionalProperties", "columns", "container", "content", "date", "description", "drill_down", "enable_section_headers", "ignore_dashboard_filters", "ignored_filters", "interactions", "layout_direction", "metric", "rows", "sections", "size", "title", "type", "visualization", "zoom_data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualizations"]) -> MetaOapg.properties.visualizations: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["additionalProperties"]) -> typing.Union[MetaOapg.properties.additionalProperties, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> typing.Union[MetaOapg.properties.columns, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["container"]) -> typing.Union[MetaOapg.properties.container, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union[MetaOapg.properties.content, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["date"]) -> typing.Union[MetaOapg.properties.date, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["drill_down"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["enable_section_headers"]) -> typing.Union[MetaOapg.properties.enable_section_headers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["ignore_dashboard_filters"]) -> typing.Union[MetaOapg.properties.ignore_dashboard_filters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["ignored_filters"]) -> typing.Union[MetaOapg.properties.ignored_filters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["interactions"]) -> typing.Union[MetaOapg.properties.interactions, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["layout_direction"]) -> typing.Union[MetaOapg.properties.layout_direction, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metric"]) -> typing.Union[MetaOapg.properties.metric, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rows"]) -> typing.Union[MetaOapg.properties.rows, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sections"]) -> typing.Union[MetaOapg.properties.sections, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["size"]) -> typing.Union['AacWidgetSize', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> typing.Union[MetaOapg.properties.type, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualization"]) -> typing.Union[MetaOapg.properties.visualization, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["zoom_data"]) -> typing.Union[MetaOapg.properties.zoom_data, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["visualizations", "additionalProperties", "columns", "container", "content", "date", "description", "drill_down", "enable_section_headers", "ignore_dashboard_filters", "ignored_filters", "interactions", "layout_direction", "metric", "rows", "sections", "size", "title", "type", "visualization", "zoom_data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + visualizations: typing.Union[MetaOapg.properties.visualizations, list, tuple, ], + additionalProperties: typing.Union[MetaOapg.properties.additionalProperties, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + columns: typing.Union[MetaOapg.properties.columns, decimal.Decimal, int, schemas.Unset] = schemas.unset, + container: typing.Union[MetaOapg.properties.container, str, schemas.Unset] = schemas.unset, + content: typing.Union[MetaOapg.properties.content, str, schemas.Unset] = schemas.unset, + date: typing.Union[MetaOapg.properties.date, str, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + drill_down: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + enable_section_headers: typing.Union[MetaOapg.properties.enable_section_headers, bool, schemas.Unset] = schemas.unset, + ignore_dashboard_filters: typing.Union[MetaOapg.properties.ignore_dashboard_filters, list, tuple, schemas.Unset] = schemas.unset, + ignored_filters: typing.Union[MetaOapg.properties.ignored_filters, list, tuple, schemas.Unset] = schemas.unset, + interactions: typing.Union[MetaOapg.properties.interactions, list, tuple, schemas.Unset] = schemas.unset, + layout_direction: typing.Union[MetaOapg.properties.layout_direction, str, schemas.Unset] = schemas.unset, + metric: typing.Union[MetaOapg.properties.metric, str, schemas.Unset] = schemas.unset, + rows: typing.Union[MetaOapg.properties.rows, decimal.Decimal, int, schemas.Unset] = schemas.unset, + sections: typing.Union[MetaOapg.properties.sections, list, tuple, schemas.Unset] = schemas.unset, + size: typing.Union['AacWidgetSize', schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + type: typing.Union[MetaOapg.properties.type, str, schemas.Unset] = schemas.unset, + visualization: typing.Union[MetaOapg.properties.visualization, str, schemas.Unset] = schemas.unset, + zoom_data: typing.Union[MetaOapg.properties.zoom_data, bool, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacVisualizationSwitcherWidget': + return super().__new__( + cls, + *_args, + visualizations=visualizations, + additionalProperties=additionalProperties, + columns=columns, + container=container, + content=content, + date=date, + description=description, + drill_down=drill_down, + enable_section_headers=enable_section_headers, + ignore_dashboard_filters=ignore_dashboard_filters, + ignored_filters=ignored_filters, + interactions=interactions, + layout_direction=layout_direction, + metric=metric, + rows=rows, + sections=sections, + size=size, + title=title, + type=type, + visualization=visualization, + zoom_data=zoom_data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_section import AacSection +from gooddata_api_client.model.aac_visualization_widget import AacVisualizationWidget +from gooddata_api_client.model.aac_widget_size import AacWidgetSize +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_visualization_table_buckets.pyi b/gooddata-api-client/gooddata_api_client/model/aac_visualization_table_buckets.pyi new file mode 100644 index 000000000..40bc087fb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_visualization_table_buckets.pyi @@ -0,0 +1,1329 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacVisualizationTableBuckets( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "query", + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + @staticmethod + def query() -> typing.Type['AacQuery']: + return AacQuery + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def TABLE(cls): + return cls("table") + + @schemas.classproperty + def HEATMAP_CHART(cls): + return cls("heatmap_chart") + + @schemas.classproperty + def REPEATER_CHART(cls): + return cls("repeater_chart") + + + class additionalProperties( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['JsonNode']: + return JsonNode + + def __getitem__(self, name: typing.Union[str, ]) -> 'JsonNode': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'JsonNode': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'JsonNode', + ) -> 'additionalProperties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class attributes( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attributes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class columns( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'columns': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def config() -> typing.Type['JsonNode']: + return JsonNode + description = schemas.StrSchema + + @staticmethod + def _from() -> typing.Type['JsonNode']: + return JsonNode + is_hidden = schemas.BoolSchema + + + class layers( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacVisualizationLayer']: + return AacVisualizationLayer + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacVisualizationLayer'], typing.List['AacVisualizationLayer']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'layers': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacVisualizationLayer': + return super().__getitem__(i) + + + class metrics( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'metrics': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class rows( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'rows': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class segment_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'segment_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + show_in_ai_results = schemas.BoolSchema + + + class size_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'size_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class stack_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'stack_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + + @staticmethod + def to() -> typing.Type['JsonNode']: + return JsonNode + + + class trend_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'trend_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class view_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'view_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "id": id, + "query": query, + "type": type, + "additionalProperties": additionalProperties, + "attributes": attributes, + "columns": columns, + "config": config, + "description": description, + "from": _from, + "is_hidden": is_hidden, + "layers": layers, + "metrics": metrics, + "rows": rows, + "segment_by": segment_by, + "show_in_ai_results": show_in_ai_results, + "size_by": size_by, + "stack_by": stack_by, + "tags": tags, + "title": title, + "to": to, + "trend_by": trend_by, + "view_by": view_by, + } + + + class all_of_0( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "from", + } + + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_1( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "to", + } + + + to: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_2( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "stack_by", + } + + + stack_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_2': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_3( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "trend_by", + } + + + trend_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_3': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_4( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "size_by", + } + + + size_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_4': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_5( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "attributes", + } + + + attributes: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_5': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_6( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "layers", + } + + + layers: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_6': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + cls.all_of_1, + cls.all_of_2, + cls.all_of_3, + cls.all_of_4, + cls.all_of_5, + cls.all_of_6, + ] + + + query: 'AacQuery' + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["query"]) -> 'AacQuery': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["additionalProperties"]) -> MetaOapg.properties.additionalProperties: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["config"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["is_hidden"]) -> MetaOapg.properties.is_hidden: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["layers"]) -> MetaOapg.properties.layers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rows"]) -> MetaOapg.properties.rows: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["segment_by"]) -> MetaOapg.properties.segment_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["show_in_ai_results"]) -> MetaOapg.properties.show_in_ai_results: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["size_by"]) -> MetaOapg.properties.size_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["stack_by"]) -> MetaOapg.properties.stack_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["trend_by"]) -> MetaOapg.properties.trend_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["view_by"]) -> MetaOapg.properties.view_by: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "query", "type", "additionalProperties", "attributes", "columns", "config", "description", "from", "is_hidden", "layers", "metrics", "rows", "segment_by", "show_in_ai_results", "size_by", "stack_by", "tags", "title", "to", "trend_by", "view_by", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["query"]) -> 'AacQuery': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["additionalProperties"]) -> typing.Union[MetaOapg.properties.additionalProperties, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> typing.Union[MetaOapg.properties.columns, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["config"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["is_hidden"]) -> typing.Union[MetaOapg.properties.is_hidden, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["layers"]) -> typing.Union[MetaOapg.properties.layers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rows"]) -> typing.Union[MetaOapg.properties.rows, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["segment_by"]) -> typing.Union[MetaOapg.properties.segment_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["show_in_ai_results"]) -> typing.Union[MetaOapg.properties.show_in_ai_results, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["size_by"]) -> typing.Union[MetaOapg.properties.size_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["stack_by"]) -> typing.Union[MetaOapg.properties.stack_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["trend_by"]) -> typing.Union[MetaOapg.properties.trend_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["view_by"]) -> typing.Union[MetaOapg.properties.view_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "query", "type", "additionalProperties", "attributes", "columns", "config", "description", "from", "is_hidden", "layers", "metrics", "rows", "segment_by", "show_in_ai_results", "size_by", "stack_by", "tags", "title", "to", "trend_by", "view_by", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + query: 'AacQuery', + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + additionalProperties: typing.Union[MetaOapg.properties.additionalProperties, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + attributes: typing.Union[MetaOapg.properties.attributes, list, tuple, schemas.Unset] = schemas.unset, + columns: typing.Union[MetaOapg.properties.columns, list, tuple, schemas.Unset] = schemas.unset, + config: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + is_hidden: typing.Union[MetaOapg.properties.is_hidden, bool, schemas.Unset] = schemas.unset, + layers: typing.Union[MetaOapg.properties.layers, list, tuple, schemas.Unset] = schemas.unset, + metrics: typing.Union[MetaOapg.properties.metrics, list, tuple, schemas.Unset] = schemas.unset, + rows: typing.Union[MetaOapg.properties.rows, list, tuple, schemas.Unset] = schemas.unset, + segment_by: typing.Union[MetaOapg.properties.segment_by, list, tuple, schemas.Unset] = schemas.unset, + show_in_ai_results: typing.Union[MetaOapg.properties.show_in_ai_results, bool, schemas.Unset] = schemas.unset, + size_by: typing.Union[MetaOapg.properties.size_by, list, tuple, schemas.Unset] = schemas.unset, + stack_by: typing.Union[MetaOapg.properties.stack_by, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + to: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + trend_by: typing.Union[MetaOapg.properties.trend_by, list, tuple, schemas.Unset] = schemas.unset, + view_by: typing.Union[MetaOapg.properties.view_by, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacVisualizationTableBuckets': + return super().__new__( + cls, + *_args, + query=query, + id=id, + type=type, + additionalProperties=additionalProperties, + attributes=attributes, + columns=columns, + config=config, + description=description, + is_hidden=is_hidden, + layers=layers, + metrics=metrics, + rows=rows, + segment_by=segment_by, + show_in_ai_results=show_in_ai_results, + size_by=size_by, + stack_by=stack_by, + tags=tags, + title=title, + to=to, + trend_by=trend_by, + view_by=view_by, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_query import AacQuery +from gooddata_api_client.model.aac_visualization_layer import AacVisualizationLayer +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_visualization_trend_buckets.pyi b/gooddata-api-client/gooddata_api_client/model/aac_visualization_trend_buckets.pyi new file mode 100644 index 000000000..113ed011b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_visualization_trend_buckets.pyi @@ -0,0 +1,1371 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacVisualizationTrendBuckets( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "query", + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + @staticmethod + def query() -> typing.Type['AacQuery']: + return AacQuery + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def LINE_CHART(cls): + return cls("line_chart") + + + class additionalProperties( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['JsonNode']: + return JsonNode + + def __getitem__(self, name: typing.Union[str, ]) -> 'JsonNode': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'JsonNode': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'JsonNode', + ) -> 'additionalProperties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class attributes( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attributes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class columns( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'columns': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def config() -> typing.Type['JsonNode']: + return JsonNode + description = schemas.StrSchema + + @staticmethod + def _from() -> typing.Type['JsonNode']: + return JsonNode + is_hidden = schemas.BoolSchema + + + class layers( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacVisualizationLayer']: + return AacVisualizationLayer + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacVisualizationLayer'], typing.List['AacVisualizationLayer']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'layers': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacVisualizationLayer': + return super().__getitem__(i) + + + class metrics( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'metrics': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class rows( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'rows': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class segment_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'segment_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + show_in_ai_results = schemas.BoolSchema + + + class size_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'size_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class stack_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'stack_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + + @staticmethod + def to() -> typing.Type['JsonNode']: + return JsonNode + + + class trend_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'trend_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class view_by( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.DictSchema + one_of_2 = schemas.NoneSchema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'view_by': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "id": id, + "query": query, + "type": type, + "additionalProperties": additionalProperties, + "attributes": attributes, + "columns": columns, + "config": config, + "description": description, + "from": _from, + "is_hidden": is_hidden, + "layers": layers, + "metrics": metrics, + "rows": rows, + "segment_by": segment_by, + "show_in_ai_results": show_in_ai_results, + "size_by": size_by, + "stack_by": stack_by, + "tags": tags, + "title": title, + "to": to, + "trend_by": trend_by, + "view_by": view_by, + } + + + class all_of_0( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "rows", + } + + + rows: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_1( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "columns", + } + + + columns: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_2( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "from", + } + + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_2': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_3( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "to", + } + + + to: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_3': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_4( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "stack_by", + } + + + stack_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_4': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_5( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "size_by", + } + + + size_by: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_5': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_6( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "attributes", + } + + + attributes: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_6': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_7( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "layers", + } + + + layers: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_7': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + cls.all_of_1, + cls.all_of_2, + cls.all_of_3, + cls.all_of_4, + cls.all_of_5, + cls.all_of_6, + cls.all_of_7, + ] + + + query: 'AacQuery' + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["query"]) -> 'AacQuery': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["additionalProperties"]) -> MetaOapg.properties.additionalProperties: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["config"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["is_hidden"]) -> MetaOapg.properties.is_hidden: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["layers"]) -> MetaOapg.properties.layers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rows"]) -> MetaOapg.properties.rows: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["segment_by"]) -> MetaOapg.properties.segment_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["show_in_ai_results"]) -> MetaOapg.properties.show_in_ai_results: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["size_by"]) -> MetaOapg.properties.size_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["stack_by"]) -> MetaOapg.properties.stack_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["trend_by"]) -> MetaOapg.properties.trend_by: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["view_by"]) -> MetaOapg.properties.view_by: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "query", "type", "additionalProperties", "attributes", "columns", "config", "description", "from", "is_hidden", "layers", "metrics", "rows", "segment_by", "show_in_ai_results", "size_by", "stack_by", "tags", "title", "to", "trend_by", "view_by", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["query"]) -> 'AacQuery': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["additionalProperties"]) -> typing.Union[MetaOapg.properties.additionalProperties, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> typing.Union[MetaOapg.properties.columns, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["config"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["is_hidden"]) -> typing.Union[MetaOapg.properties.is_hidden, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["layers"]) -> typing.Union[MetaOapg.properties.layers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rows"]) -> typing.Union[MetaOapg.properties.rows, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["segment_by"]) -> typing.Union[MetaOapg.properties.segment_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["show_in_ai_results"]) -> typing.Union[MetaOapg.properties.show_in_ai_results, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["size_by"]) -> typing.Union[MetaOapg.properties.size_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["stack_by"]) -> typing.Union[MetaOapg.properties.stack_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["trend_by"]) -> typing.Union[MetaOapg.properties.trend_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["view_by"]) -> typing.Union[MetaOapg.properties.view_by, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "query", "type", "additionalProperties", "attributes", "columns", "config", "description", "from", "is_hidden", "layers", "metrics", "rows", "segment_by", "show_in_ai_results", "size_by", "stack_by", "tags", "title", "to", "trend_by", "view_by", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + query: 'AacQuery', + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + additionalProperties: typing.Union[MetaOapg.properties.additionalProperties, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + attributes: typing.Union[MetaOapg.properties.attributes, list, tuple, schemas.Unset] = schemas.unset, + columns: typing.Union[MetaOapg.properties.columns, list, tuple, schemas.Unset] = schemas.unset, + config: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + is_hidden: typing.Union[MetaOapg.properties.is_hidden, bool, schemas.Unset] = schemas.unset, + layers: typing.Union[MetaOapg.properties.layers, list, tuple, schemas.Unset] = schemas.unset, + metrics: typing.Union[MetaOapg.properties.metrics, list, tuple, schemas.Unset] = schemas.unset, + rows: typing.Union[MetaOapg.properties.rows, list, tuple, schemas.Unset] = schemas.unset, + segment_by: typing.Union[MetaOapg.properties.segment_by, list, tuple, schemas.Unset] = schemas.unset, + show_in_ai_results: typing.Union[MetaOapg.properties.show_in_ai_results, bool, schemas.Unset] = schemas.unset, + size_by: typing.Union[MetaOapg.properties.size_by, list, tuple, schemas.Unset] = schemas.unset, + stack_by: typing.Union[MetaOapg.properties.stack_by, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + to: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + trend_by: typing.Union[MetaOapg.properties.trend_by, list, tuple, schemas.Unset] = schemas.unset, + view_by: typing.Union[MetaOapg.properties.view_by, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacVisualizationTrendBuckets': + return super().__new__( + cls, + *_args, + query=query, + id=id, + type=type, + additionalProperties=additionalProperties, + attributes=attributes, + columns=columns, + config=config, + description=description, + is_hidden=is_hidden, + layers=layers, + metrics=metrics, + rows=rows, + segment_by=segment_by, + show_in_ai_results=show_in_ai_results, + size_by=size_by, + stack_by=stack_by, + tags=tags, + title=title, + to=to, + trend_by=trend_by, + view_by=view_by, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_query import AacQuery +from gooddata_api_client.model.aac_visualization_layer import AacVisualizationLayer +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_visualization_widget.pyi b/gooddata-api-client/gooddata_api_client/model/aac_visualization_widget.pyi new file mode 100644 index 000000000..cc8c53732 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_visualization_widget.pyi @@ -0,0 +1,715 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacVisualizationWidget( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "visualization", + } + + class properties: + visualization = schemas.StrSchema + + + class additionalProperties( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['JsonNode']: + return JsonNode + + def __getitem__(self, name: typing.Union[str, ]) -> 'JsonNode': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'JsonNode': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'JsonNode', + ) -> 'additionalProperties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + columns = schemas.Int32Schema + container = schemas.StrSchema + content = schemas.StrSchema + date = schemas.StrSchema + + + class description( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + + + class one_of_1( + schemas.EnumBase, + schemas.BoolSchema + ): + + @schemas.classproperty + def FALSE(cls): + return cls(False) + + + class one_of_2( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INHERIT(cls): + return cls("inherit") + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + cls.one_of_2, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'description': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @staticmethod + def drill_down() -> typing.Type['JsonNode']: + return JsonNode + enable_section_headers = schemas.BoolSchema + + + class ignore_dashboard_filters( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ignore_dashboard_filters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class ignored_filters( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ignored_filters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class interactions( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonNode']: + return JsonNode + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonNode'], typing.List['JsonNode']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'interactions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonNode': + return super().__getitem__(i) + layout_direction = schemas.StrSchema + metric = schemas.StrSchema + rows = schemas.Int32Schema + + + class sections( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacSection']: + return AacSection + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacSection'], typing.List['AacSection']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'sections': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacSection': + return super().__getitem__(i) + + @staticmethod + def size() -> typing.Type['AacWidgetSize']: + return AacWidgetSize + + + class title( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + + + class one_of_1( + schemas.EnumBase, + schemas.BoolSchema + ): + + @schemas.classproperty + def FALSE(cls): + return cls(False) + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'title': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + type = schemas.StrSchema + + + class visualizations( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AacWidget']: + return AacWidget + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AacWidget'], typing.List['AacWidget']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visualizations': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AacWidget': + return super().__getitem__(i) + zoom_data = schemas.BoolSchema + __annotations__ = { + "visualization": visualization, + "additionalProperties": additionalProperties, + "columns": columns, + "container": container, + "content": content, + "date": date, + "description": description, + "drill_down": drill_down, + "enable_section_headers": enable_section_headers, + "ignore_dashboard_filters": ignore_dashboard_filters, + "ignored_filters": ignored_filters, + "interactions": interactions, + "layout_direction": layout_direction, + "metric": metric, + "rows": rows, + "sections": sections, + "size": size, + "title": title, + "type": type, + "visualizations": visualizations, + "zoom_data": zoom_data, + } + + + class all_of_0( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "content", + } + + + content: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_1( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "sections", + } + + + sections: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class all_of_2( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + + class not_schema( + schemas.AnyTypeSchema, + ): + + + class MetaOapg: + required = { + "visualizations", + } + + + visualizations: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'not_schema': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_2': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + cls.all_of_1, + cls.all_of_2, + ] + + + visualization: MetaOapg.properties.visualization + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualization"]) -> MetaOapg.properties.visualization: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["additionalProperties"]) -> MetaOapg.properties.additionalProperties: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["container"]) -> MetaOapg.properties.container: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["date"]) -> MetaOapg.properties.date: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["drill_down"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["enable_section_headers"]) -> MetaOapg.properties.enable_section_headers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["ignore_dashboard_filters"]) -> MetaOapg.properties.ignore_dashboard_filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["ignored_filters"]) -> MetaOapg.properties.ignored_filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["interactions"]) -> MetaOapg.properties.interactions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["layout_direction"]) -> MetaOapg.properties.layout_direction: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metric"]) -> MetaOapg.properties.metric: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rows"]) -> MetaOapg.properties.rows: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sections"]) -> MetaOapg.properties.sections: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["size"]) -> 'AacWidgetSize': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualizations"]) -> MetaOapg.properties.visualizations: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["zoom_data"]) -> MetaOapg.properties.zoom_data: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["visualization", "additionalProperties", "columns", "container", "content", "date", "description", "drill_down", "enable_section_headers", "ignore_dashboard_filters", "ignored_filters", "interactions", "layout_direction", "metric", "rows", "sections", "size", "title", "type", "visualizations", "zoom_data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualization"]) -> MetaOapg.properties.visualization: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["additionalProperties"]) -> typing.Union[MetaOapg.properties.additionalProperties, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> typing.Union[MetaOapg.properties.columns, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["container"]) -> typing.Union[MetaOapg.properties.container, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union[MetaOapg.properties.content, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["date"]) -> typing.Union[MetaOapg.properties.date, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["drill_down"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["enable_section_headers"]) -> typing.Union[MetaOapg.properties.enable_section_headers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["ignore_dashboard_filters"]) -> typing.Union[MetaOapg.properties.ignore_dashboard_filters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["ignored_filters"]) -> typing.Union[MetaOapg.properties.ignored_filters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["interactions"]) -> typing.Union[MetaOapg.properties.interactions, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["layout_direction"]) -> typing.Union[MetaOapg.properties.layout_direction, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metric"]) -> typing.Union[MetaOapg.properties.metric, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rows"]) -> typing.Union[MetaOapg.properties.rows, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sections"]) -> typing.Union[MetaOapg.properties.sections, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["size"]) -> typing.Union['AacWidgetSize', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> typing.Union[MetaOapg.properties.type, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualizations"]) -> typing.Union[MetaOapg.properties.visualizations, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["zoom_data"]) -> typing.Union[MetaOapg.properties.zoom_data, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["visualization", "additionalProperties", "columns", "container", "content", "date", "description", "drill_down", "enable_section_headers", "ignore_dashboard_filters", "ignored_filters", "interactions", "layout_direction", "metric", "rows", "sections", "size", "title", "type", "visualizations", "zoom_data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + visualization: typing.Union[MetaOapg.properties.visualization, str, ], + additionalProperties: typing.Union[MetaOapg.properties.additionalProperties, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + columns: typing.Union[MetaOapg.properties.columns, decimal.Decimal, int, schemas.Unset] = schemas.unset, + container: typing.Union[MetaOapg.properties.container, str, schemas.Unset] = schemas.unset, + content: typing.Union[MetaOapg.properties.content, str, schemas.Unset] = schemas.unset, + date: typing.Union[MetaOapg.properties.date, str, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + drill_down: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + enable_section_headers: typing.Union[MetaOapg.properties.enable_section_headers, bool, schemas.Unset] = schemas.unset, + ignore_dashboard_filters: typing.Union[MetaOapg.properties.ignore_dashboard_filters, list, tuple, schemas.Unset] = schemas.unset, + ignored_filters: typing.Union[MetaOapg.properties.ignored_filters, list, tuple, schemas.Unset] = schemas.unset, + interactions: typing.Union[MetaOapg.properties.interactions, list, tuple, schemas.Unset] = schemas.unset, + layout_direction: typing.Union[MetaOapg.properties.layout_direction, str, schemas.Unset] = schemas.unset, + metric: typing.Union[MetaOapg.properties.metric, str, schemas.Unset] = schemas.unset, + rows: typing.Union[MetaOapg.properties.rows, decimal.Decimal, int, schemas.Unset] = schemas.unset, + sections: typing.Union[MetaOapg.properties.sections, list, tuple, schemas.Unset] = schemas.unset, + size: typing.Union['AacWidgetSize', schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + type: typing.Union[MetaOapg.properties.type, str, schemas.Unset] = schemas.unset, + visualizations: typing.Union[MetaOapg.properties.visualizations, list, tuple, schemas.Unset] = schemas.unset, + zoom_data: typing.Union[MetaOapg.properties.zoom_data, bool, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacVisualizationWidget': + return super().__new__( + cls, + *_args, + visualization=visualization, + additionalProperties=additionalProperties, + columns=columns, + container=container, + content=content, + date=date, + description=description, + drill_down=drill_down, + enable_section_headers=enable_section_headers, + ignore_dashboard_filters=ignore_dashboard_filters, + ignored_filters=ignored_filters, + interactions=interactions, + layout_direction=layout_direction, + metric=metric, + rows=rows, + sections=sections, + size=size, + title=title, + type=type, + visualizations=visualizations, + zoom_data=zoom_data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_section import AacSection +from gooddata_api_client.model.aac_widget import AacWidget +from gooddata_api_client.model.aac_widget_size import AacWidgetSize +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/aac_widget.pyi b/gooddata-api-client/gooddata_api_client/model/aac_widget.pyi new file mode 100644 index 000000000..3607cbc49 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_widget.pyi @@ -0,0 +1,75 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacWidget( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Widgets in the section. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AacVisualizationWidget, + AacRichTextWidget, + AacVisualizationSwitcherWidget, + AacContainerWidget, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacWidget': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aac_container_widget import AacContainerWidget +from gooddata_api_client.model.aac_rich_text_widget import AacRichTextWidget +from gooddata_api_client.model.aac_visualization_switcher_widget import AacVisualizationSwitcherWidget +from gooddata_api_client.model.aac_visualization_widget import AacVisualizationWidget diff --git a/gooddata-api-client/gooddata_api_client/model/aac_widget_size.pyi b/gooddata-api-client/gooddata_api_client/model/aac_widget_size.pyi new file mode 100644 index 000000000..b3a1c5014 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_widget_size.pyi @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacWidgetSize( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Deprecated widget size (legacy AAC). + """ + + + class MetaOapg: + + class properties: + height = schemas.Int32Schema + height_as_ratio = schemas.BoolSchema + width = schemas.Int32Schema + __annotations__ = { + "height": height, + "height_as_ratio": height_as_ratio, + "width": width, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["height"]) -> MetaOapg.properties.height: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["height_as_ratio"]) -> MetaOapg.properties.height_as_ratio: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["width"]) -> MetaOapg.properties.width: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["height", "height_as_ratio", "width", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["height"]) -> typing.Union[MetaOapg.properties.height, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["height_as_ratio"]) -> typing.Union[MetaOapg.properties.height_as_ratio, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["width"]) -> typing.Union[MetaOapg.properties.width, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["height", "height_as_ratio", "width", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + height: typing.Union[MetaOapg.properties.height, decimal.Decimal, int, schemas.Unset] = schemas.unset, + height_as_ratio: typing.Union[MetaOapg.properties.height_as_ratio, bool, schemas.Unset] = schemas.unset, + width: typing.Union[MetaOapg.properties.width, decimal.Decimal, int, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacWidgetSize': + return super().__new__( + cls, + *_args, + height=height, + height_as_ratio=height_as_ratio, + width=width, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/aac_workspace_data_filter.pyi b/gooddata-api-client/gooddata_api_client/model/aac_workspace_data_filter.pyi new file mode 100644 index 000000000..0ec8afd86 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aac_workspace_data_filter.pyi @@ -0,0 +1,143 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AacWorkspaceDataFilter( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Workspace data filters. + """ + + + class MetaOapg: + required = { + "source_column", + "filter_id", + "data_type", + } + + class properties: + + + class data_type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INT(cls): + return cls("INT") + + @schemas.classproperty + def STRING(cls): + return cls("STRING") + + @schemas.classproperty + def DATE(cls): + return cls("DATE") + + @schemas.classproperty + def NUMERIC(cls): + return cls("NUMERIC") + + @schemas.classproperty + def TIMESTAMP(cls): + return cls("TIMESTAMP") + + @schemas.classproperty + def TIMESTAMP_TZ(cls): + return cls("TIMESTAMP_TZ") + + @schemas.classproperty + def BOOLEAN(cls): + return cls("BOOLEAN") + filter_id = schemas.StrSchema + source_column = schemas.StrSchema + __annotations__ = { + "data_type": data_type, + "filter_id": filter_id, + "source_column": source_column, + } + + source_column: MetaOapg.properties.source_column + filter_id: MetaOapg.properties.filter_id + data_type: MetaOapg.properties.data_type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data_type"]) -> MetaOapg.properties.data_type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filter_id"]) -> MetaOapg.properties.filter_id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["source_column"]) -> MetaOapg.properties.source_column: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data_type", "filter_id", "source_column", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data_type"]) -> MetaOapg.properties.data_type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filter_id"]) -> MetaOapg.properties.filter_id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["source_column"]) -> MetaOapg.properties.source_column: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data_type", "filter_id", "source_column", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + source_column: typing.Union[MetaOapg.properties.source_column, str, ], + filter_id: typing.Union[MetaOapg.properties.filter_id, str, ], + data_type: typing.Union[MetaOapg.properties.data_type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AacWorkspaceDataFilter': + return super().__new__( + cls, + *_args, + source_column=source_column, + filter_id=filter_id, + data_type=data_type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py b/gooddata-api-client/gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py index e8c58c77c..44320c1d5 100644 --- a/gooddata-api-client/gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py @@ -104,10 +104,10 @@ def openapi_types(): lazy_import() return { 'dataset': (AfmObjectIdentifierDataset,), # noqa: E501 - 'empty_value_handling': (str,), # noqa: E501 '_from': (str,), # noqa: E501 'to': (str,), # noqa: E501 'apply_on_result': (bool,), # noqa: E501 + 'empty_value_handling': (str,), # noqa: E501 'local_identifier': (str,), # noqa: E501 } @@ -118,10 +118,10 @@ def discriminator(): attribute_map = { 'dataset': 'dataset', # noqa: E501 - 'empty_value_handling': 'emptyValueHandling', # noqa: E501 '_from': 'from', # noqa: E501 'to': 'to', # noqa: E501 'apply_on_result': 'applyOnResult', # noqa: E501 + 'empty_value_handling': 'emptyValueHandling', # noqa: E501 'local_identifier': 'localIdentifier', # noqa: E501 } @@ -172,6 +172,7 @@ def _from_openapi_data(cls, dataset, _from, to, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) apply_on_result (bool): [optional] # noqa: E501 + empty_value_handling (str): Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.. [optional] if omitted the server will use the default value of "EXCLUDE" # noqa: E501 local_identifier (str): [optional] # noqa: E501 """ @@ -267,6 +268,7 @@ def __init__(self, dataset, _from, to, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) apply_on_result (bool): [optional] # noqa: E501 + empty_value_handling (str): Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.. [optional] if omitted the server will use the default value of "EXCLUDE" # noqa: E501 local_identifier (str): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/active_object_identification.pyi b/gooddata-api-client/gooddata_api_client/model/active_object_identification.pyi new file mode 100644 index 000000000..d9b76718f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/active_object_identification.pyi @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ActiveObjectIdentification( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Object, with which the user is actively working. + """ + + + class MetaOapg: + required = { + "id", + "type", + "workspaceId", + } + + class properties: + id = schemas.StrSchema + type = schemas.StrSchema + workspaceId = schemas.StrSchema + __annotations__ = { + "id": id, + "type": type, + "workspaceId": workspaceId, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + workspaceId: MetaOapg.properties.workspaceId + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workspaceId"]) -> MetaOapg.properties.workspaceId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "workspaceId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workspaceId"]) -> MetaOapg.properties.workspaceId: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "workspaceId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + workspaceId: typing.Union[MetaOapg.properties.workspaceId, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ActiveObjectIdentification': + return super().__new__( + cls, + *_args, + id=id, + type=type, + workspaceId=workspaceId, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/ad_hoc_automation.pyi b/gooddata-api-client/gooddata_api_client/model/ad_hoc_automation.pyi new file mode 100644 index 000000000..612fba60b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/ad_hoc_automation.pyi @@ -0,0 +1,519 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AdHocAutomation( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + @staticmethod + def alert() -> typing.Type['AutomationAlert']: + return AutomationAlert + + @staticmethod + def analyticalDashboard() -> typing.Type['DeclarativeAnalyticalDashboardIdentifier']: + return DeclarativeAnalyticalDashboardIdentifier + + + class dashboardTabularExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AutomationDashboardTabularExport']: + return AutomationDashboardTabularExport + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AutomationDashboardTabularExport'], typing.List['AutomationDashboardTabularExport']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dashboardTabularExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AutomationDashboardTabularExport': + return super().__getitem__(i) + + + class description( + schemas.StrSchema + ): + pass + + + class details( + schemas.DictSchema + ): + + + class MetaOapg: + + + class additional_properties( + schemas.StrSchema + ): + pass + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, str, ], + ) -> 'details': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class externalRecipients( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AutomationExternalRecipient']: + return AutomationExternalRecipient + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AutomationExternalRecipient'], typing.List['AutomationExternalRecipient']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'externalRecipients': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AutomationExternalRecipient': + return super().__getitem__(i) + + + class imageExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AutomationImageExport']: + return AutomationImageExport + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AutomationImageExport'], typing.List['AutomationImageExport']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'imageExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AutomationImageExport': + return super().__getitem__(i) + + @staticmethod + def metadata() -> typing.Type['AutomationMetadata']: + return AutomationMetadata + + @staticmethod + def notificationChannel() -> typing.Type['DeclarativeNotificationChannelIdentifier']: + return DeclarativeNotificationChannelIdentifier + + + class rawExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AutomationRawExport']: + return AutomationRawExport + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AutomationRawExport'], typing.List['AutomationRawExport']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'rawExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AutomationRawExport': + return super().__getitem__(i) + + + class recipients( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeUserIdentifier']: + return DeclarativeUserIdentifier + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeUserIdentifier'], typing.List['DeclarativeUserIdentifier']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'recipients': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeUserIdentifier': + return super().__getitem__(i) + + + class slidesExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AutomationSlidesExport']: + return AutomationSlidesExport + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AutomationSlidesExport'], typing.List['AutomationSlidesExport']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'slidesExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AutomationSlidesExport': + return super().__getitem__(i) + + + class tabularExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AutomationTabularExport']: + return AutomationTabularExport + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AutomationTabularExport'], typing.List['AutomationTabularExport']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tabularExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AutomationTabularExport': + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + + + class visualExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AutomationVisualExport']: + return AutomationVisualExport + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AutomationVisualExport'], typing.List['AutomationVisualExport']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visualExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AutomationVisualExport': + return super().__getitem__(i) + __annotations__ = { + "alert": alert, + "analyticalDashboard": analyticalDashboard, + "dashboardTabularExports": dashboardTabularExports, + "description": description, + "details": details, + "externalRecipients": externalRecipients, + "imageExports": imageExports, + "metadata": metadata, + "notificationChannel": notificationChannel, + "rawExports": rawExports, + "recipients": recipients, + "slidesExports": slidesExports, + "tabularExports": tabularExports, + "tags": tags, + "title": title, + "visualExports": visualExports, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["alert"]) -> 'AutomationAlert': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> 'DeclarativeAnalyticalDashboardIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardTabularExports"]) -> MetaOapg.properties.dashboardTabularExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["details"]) -> MetaOapg.properties.details: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["externalRecipients"]) -> MetaOapg.properties.externalRecipients: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["imageExports"]) -> MetaOapg.properties.imageExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metadata"]) -> 'AutomationMetadata': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["notificationChannel"]) -> 'DeclarativeNotificationChannelIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rawExports"]) -> MetaOapg.properties.rawExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["recipients"]) -> MetaOapg.properties.recipients: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["slidesExports"]) -> MetaOapg.properties.slidesExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tabularExports"]) -> MetaOapg.properties.tabularExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualExports"]) -> MetaOapg.properties.visualExports: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["alert", "analyticalDashboard", "dashboardTabularExports", "description", "details", "externalRecipients", "imageExports", "metadata", "notificationChannel", "rawExports", "recipients", "slidesExports", "tabularExports", "tags", "title", "visualExports", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["alert"]) -> typing.Union['AutomationAlert', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union['DeclarativeAnalyticalDashboardIdentifier', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardTabularExports"]) -> typing.Union[MetaOapg.properties.dashboardTabularExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["details"]) -> typing.Union[MetaOapg.properties.details, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["externalRecipients"]) -> typing.Union[MetaOapg.properties.externalRecipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["imageExports"]) -> typing.Union[MetaOapg.properties.imageExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metadata"]) -> typing.Union['AutomationMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["notificationChannel"]) -> typing.Union['DeclarativeNotificationChannelIdentifier', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rawExports"]) -> typing.Union[MetaOapg.properties.rawExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["recipients"]) -> typing.Union[MetaOapg.properties.recipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["slidesExports"]) -> typing.Union[MetaOapg.properties.slidesExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tabularExports"]) -> typing.Union[MetaOapg.properties.tabularExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualExports"]) -> typing.Union[MetaOapg.properties.visualExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["alert", "analyticalDashboard", "dashboardTabularExports", "description", "details", "externalRecipients", "imageExports", "metadata", "notificationChannel", "rawExports", "recipients", "slidesExports", "tabularExports", "tags", "title", "visualExports", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + alert: typing.Union['AutomationAlert', schemas.Unset] = schemas.unset, + analyticalDashboard: typing.Union['DeclarativeAnalyticalDashboardIdentifier', schemas.Unset] = schemas.unset, + dashboardTabularExports: typing.Union[MetaOapg.properties.dashboardTabularExports, list, tuple, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + details: typing.Union[MetaOapg.properties.details, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + externalRecipients: typing.Union[MetaOapg.properties.externalRecipients, list, tuple, schemas.Unset] = schemas.unset, + imageExports: typing.Union[MetaOapg.properties.imageExports, list, tuple, schemas.Unset] = schemas.unset, + metadata: typing.Union['AutomationMetadata', schemas.Unset] = schemas.unset, + notificationChannel: typing.Union['DeclarativeNotificationChannelIdentifier', schemas.Unset] = schemas.unset, + rawExports: typing.Union[MetaOapg.properties.rawExports, list, tuple, schemas.Unset] = schemas.unset, + recipients: typing.Union[MetaOapg.properties.recipients, list, tuple, schemas.Unset] = schemas.unset, + slidesExports: typing.Union[MetaOapg.properties.slidesExports, list, tuple, schemas.Unset] = schemas.unset, + tabularExports: typing.Union[MetaOapg.properties.tabularExports, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + visualExports: typing.Union[MetaOapg.properties.visualExports, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AdHocAutomation': + return super().__new__( + cls, + *_args, + alert=alert, + analyticalDashboard=analyticalDashboard, + dashboardTabularExports=dashboardTabularExports, + description=description, + details=details, + externalRecipients=externalRecipients, + imageExports=imageExports, + metadata=metadata, + notificationChannel=notificationChannel, + rawExports=rawExports, + recipients=recipients, + slidesExports=slidesExports, + tabularExports=tabularExports, + tags=tags, + title=title, + visualExports=visualExports, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.automation_alert import AutomationAlert +from gooddata_api_client.model.automation_dashboard_tabular_export import AutomationDashboardTabularExport +from gooddata_api_client.model.automation_external_recipient import AutomationExternalRecipient +from gooddata_api_client.model.automation_image_export import AutomationImageExport +from gooddata_api_client.model.automation_metadata import AutomationMetadata +from gooddata_api_client.model.automation_raw_export import AutomationRawExport +from gooddata_api_client.model.automation_slides_export import AutomationSlidesExport +from gooddata_api_client.model.automation_tabular_export import AutomationTabularExport +from gooddata_api_client.model.automation_visual_export import AutomationVisualExport +from gooddata_api_client.model.declarative_analytical_dashboard_identifier import DeclarativeAnalyticalDashboardIdentifier +from gooddata_api_client.model.declarative_notification_channel_identifier import DeclarativeNotificationChannelIdentifier +from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/afm.py b/gooddata-api-client/gooddata_api_client/model/afm.py index 97eb90fd3..b8a29d7f9 100644 --- a/gooddata-api-client/gooddata_api_client/model/afm.py +++ b/gooddata-api-client/gooddata_api_client/model/afm.py @@ -34,9 +34,11 @@ def lazy_import(): from gooddata_api_client.model.afm_filters_inner import AFMFiltersInner from gooddata_api_client.model.attribute_item import AttributeItem from gooddata_api_client.model.measure_item import MeasureItem + from gooddata_api_client.model.metric_definition_override import MetricDefinitionOverride globals()['AFMFiltersInner'] = AFMFiltersInner globals()['AttributeItem'] = AttributeItem globals()['MeasureItem'] = MeasureItem + globals()['MetricDefinitionOverride'] = MetricDefinitionOverride class AFM(ModelNormal): @@ -96,6 +98,7 @@ def openapi_types(): 'filters': ([AFMFiltersInner],), # noqa: E501 'measures': ([MeasureItem],), # noqa: E501 'aux_measures': ([MeasureItem],), # noqa: E501 + 'measure_definition_overrides': ([MetricDefinitionOverride],), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'filters': 'filters', # noqa: E501 'measures': 'measures', # noqa: E501 'aux_measures': 'auxMeasures', # noqa: E501 + 'measure_definition_overrides': 'measureDefinitionOverrides', # noqa: E501 } read_only_vars = { @@ -157,6 +161,7 @@ def _from_openapi_data(cls, attributes, filters, measures, *args, **kwargs): # through its discriminator because we passed in _visited_composed_classes = (Animal,) aux_measures ([MeasureItem]): Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.. [optional] # noqa: E501 + measure_definition_overrides ([MetricDefinitionOverride]): (EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric's MAQL definition without modifying the stored definition.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -251,6 +256,7 @@ def __init__(self, attributes, filters, measures, *args, **kwargs): # noqa: E50 through its discriminator because we passed in _visited_composed_classes = (Animal,) aux_measures ([MeasureItem]): Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.. [optional] # noqa: E501 + measure_definition_overrides ([MetricDefinitionOverride]): (EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric's MAQL definition without modifying the stored definition.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/afm_cancel_tokens.pyi b/gooddata-api-client/gooddata_api_client/model/afm_cancel_tokens.pyi new file mode 100644 index 000000000..89a6df7fe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/afm_cancel_tokens.pyi @@ -0,0 +1,114 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AfmCancelTokens( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Any information related to cancellation. + """ + + + class MetaOapg: + required = { + "resultIdToCancelTokenPairs", + } + + class properties: + + + class resultIdToCancelTokenPairs( + schemas.DictSchema + ): + + + class MetaOapg: + additional_properties = schemas.StrSchema + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, str, ], + ) -> 'resultIdToCancelTokenPairs': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "resultIdToCancelTokenPairs": resultIdToCancelTokenPairs, + } + + resultIdToCancelTokenPairs: MetaOapg.properties.resultIdToCancelTokenPairs + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["resultIdToCancelTokenPairs"]) -> MetaOapg.properties.resultIdToCancelTokenPairs: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["resultIdToCancelTokenPairs", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["resultIdToCancelTokenPairs"]) -> MetaOapg.properties.resultIdToCancelTokenPairs: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["resultIdToCancelTokenPairs", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + resultIdToCancelTokenPairs: typing.Union[MetaOapg.properties.resultIdToCancelTokenPairs, dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AfmCancelTokens': + return super().__new__( + cls, + *_args, + resultIdToCancelTokenPairs=resultIdToCancelTokenPairs, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/afm_filters_inner.py b/gooddata-api-client/gooddata_api_client/model/afm_filters_inner.py index 77add655b..f607f4068 100644 --- a/gooddata-api-client/gooddata_api_client/model/afm_filters_inner.py +++ b/gooddata-api-client/gooddata_api_client/model/afm_filters_inner.py @@ -32,8 +32,8 @@ def lazy_import(): from gooddata_api_client.model.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter - from gooddata_api_client.model.all_time_date_filter_all_time_date_filter import AllTimeDateFilterAllTimeDateFilter from gooddata_api_client.model.abstract_measure_value_filter import AbstractMeasureValueFilter + from gooddata_api_client.model.all_time_date_filter_all_time_date_filter import AllTimeDateFilterAllTimeDateFilter from gooddata_api_client.model.comparison_measure_value_filter_comparison_measure_value_filter import ComparisonMeasureValueFilterComparisonMeasureValueFilter from gooddata_api_client.model.compound_measure_value_filter_compound_measure_value_filter import CompoundMeasureValueFilterCompoundMeasureValueFilter from gooddata_api_client.model.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure @@ -46,8 +46,8 @@ def lazy_import(): from gooddata_api_client.model.ranking_filter_ranking_filter import RankingFilterRankingFilter from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter globals()['AbsoluteDateFilterAbsoluteDateFilter'] = AbsoluteDateFilterAbsoluteDateFilter - globals()['AllTimeDateFilterAllTimeDateFilter'] = AllTimeDateFilterAllTimeDateFilter globals()['AbstractMeasureValueFilter'] = AbstractMeasureValueFilter + globals()['AllTimeDateFilterAllTimeDateFilter'] = AllTimeDateFilterAllTimeDateFilter globals()['ComparisonMeasureValueFilterComparisonMeasureValueFilter'] = ComparisonMeasureValueFilterComparisonMeasureValueFilter globals()['CompoundMeasureValueFilterCompoundMeasureValueFilter'] = CompoundMeasureValueFilterCompoundMeasureValueFilter globals()['FilterDefinitionForSimpleMeasure'] = FilterDefinitionForSimpleMeasure @@ -112,8 +112,8 @@ def openapi_types(): 'compound_measure_value_filter': (CompoundMeasureValueFilterCompoundMeasureValueFilter,), # noqa: E501 'ranking_filter': (RankingFilterRankingFilter,), # noqa: E501 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 - 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 + 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 'negative_attribute_filter': (NegativeAttributeFilterNegativeAttributeFilter,), # noqa: E501 'positive_attribute_filter': (PositiveAttributeFilterPositiveAttributeFilter,), # noqa: E501 'match_attribute_filter': (MatchAttributeFilterMatchAttributeFilter,), # noqa: E501 @@ -131,8 +131,8 @@ def discriminator(): 'compound_measure_value_filter': 'compoundMeasureValueFilter', # noqa: E501 'ranking_filter': 'rankingFilter', # noqa: E501 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 - 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 'relative_date_filter': 'relativeDateFilter', # noqa: E501 + 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 'negative_attribute_filter': 'negativeAttributeFilter', # noqa: E501 'positive_attribute_filter': 'positiveAttributeFilter', # noqa: E501 'match_attribute_filter': 'matchAttributeFilter', # noqa: E501 @@ -184,6 +184,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 + all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 match_attribute_filter (MatchAttributeFilterMatchAttributeFilter): [optional] # noqa: E501 @@ -297,6 +298,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 + all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 match_attribute_filter (MatchAttributeFilterMatchAttributeFilter): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/afm_valid_descendants_query.pyi b/gooddata-api-client/gooddata_api_client/model/afm_valid_descendants_query.pyi new file mode 100644 index 000000000..3a6816b06 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/afm_valid_descendants_query.pyi @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AfmValidDescendantsQuery( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Entity describing the valid descendants request. + """ + + + class MetaOapg: + required = { + "attributes", + } + + class properties: + + + class attributes( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AfmObjectIdentifierAttribute']: + return AfmObjectIdentifierAttribute + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AfmObjectIdentifierAttribute'], typing.List['AfmObjectIdentifierAttribute']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attributes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AfmObjectIdentifierAttribute': + return super().__getitem__(i) + __annotations__ = { + "attributes": attributes, + } + + attributes: MetaOapg.properties.attributes + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AfmValidDescendantsQuery': + return super().__new__( + cls, + *_args, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.afm_object_identifier_attribute import AfmObjectIdentifierAttribute diff --git a/gooddata-api-client/gooddata_api_client/model/afm_valid_descendants_response.pyi b/gooddata-api-client/gooddata_api_client/model/afm_valid_descendants_response.pyi new file mode 100644 index 000000000..9a5a96a0e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/afm_valid_descendants_response.pyi @@ -0,0 +1,141 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AfmValidDescendantsResponse( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Entity describing the valid descendants response. + """ + + + class MetaOapg: + required = { + "validDescendants", + } + + class properties: + + + class validDescendants( + schemas.DictSchema + ): + + + class MetaOapg: + + + class additional_properties( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AfmObjectIdentifierAttribute']: + return AfmObjectIdentifierAttribute + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AfmObjectIdentifierAttribute'], typing.List['AfmObjectIdentifierAttribute']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'additional_properties': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AfmObjectIdentifierAttribute': + return super().__getitem__(i) + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, list, tuple, ], + ) -> 'validDescendants': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "validDescendants": validDescendants, + } + + validDescendants: MetaOapg.properties.validDescendants + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["validDescendants"]) -> MetaOapg.properties.validDescendants: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["validDescendants", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["validDescendants"]) -> MetaOapg.properties.validDescendants: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["validDescendants", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + validDescendants: typing.Union[MetaOapg.properties.validDescendants, dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AfmValidDescendantsResponse': + return super().__new__( + cls, + *_args, + validDescendants=validDescendants, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.afm_object_identifier_attribute import AfmObjectIdentifierAttribute diff --git a/gooddata-api-client/gooddata_api_client/model/alert_afm.pyi b/gooddata-api-client/gooddata_api_client/model/alert_afm.pyi new file mode 100644 index 000000000..c4255c97c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/alert_afm.pyi @@ -0,0 +1,220 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AlertAfm( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "measures", + "filters", + } + + class properties: + + + class filters( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['FilterDefinition']: + return FilterDefinition + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['FilterDefinition'], typing.List['FilterDefinition']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'filters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'FilterDefinition': + return super().__getitem__(i) + + + class measures( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['MeasureItem']: + return MeasureItem + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['MeasureItem'], typing.List['MeasureItem']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'measures': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'MeasureItem': + return super().__getitem__(i) + + + class attributes( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AttributeItem']: + return AttributeItem + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AttributeItem'], typing.List['AttributeItem']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attributes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AttributeItem': + return super().__getitem__(i) + + + class auxMeasures( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['MeasureItem']: + return MeasureItem + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['MeasureItem'], typing.List['MeasureItem']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'auxMeasures': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'MeasureItem': + return super().__getitem__(i) + __annotations__ = { + "filters": filters, + "measures": measures, + "attributes": attributes, + "auxMeasures": auxMeasures, + } + + measures: MetaOapg.properties.measures + filters: MetaOapg.properties.filters + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["measures"]) -> MetaOapg.properties.measures: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["auxMeasures"]) -> MetaOapg.properties.auxMeasures: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["filters", "measures", "attributes", "auxMeasures", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["measures"]) -> MetaOapg.properties.measures: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["auxMeasures"]) -> typing.Union[MetaOapg.properties.auxMeasures, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["filters", "measures", "attributes", "auxMeasures", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + measures: typing.Union[MetaOapg.properties.measures, list, tuple, ], + filters: typing.Union[MetaOapg.properties.filters, list, tuple, ], + attributes: typing.Union[MetaOapg.properties.attributes, list, tuple, schemas.Unset] = schemas.unset, + auxMeasures: typing.Union[MetaOapg.properties.auxMeasures, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AlertAfm': + return super().__new__( + cls, + *_args, + measures=measures, + filters=filters, + attributes=attributes, + auxMeasures=auxMeasures, + _configuration=_configuration, + **kwargs, + ) + +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 diff --git a/gooddata-api-client/gooddata_api_client/model/alert_condition.pyi b/gooddata-api-client/gooddata_api_client/model/alert_condition.pyi new file mode 100644 index 000000000..f0d272334 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/alert_condition.pyi @@ -0,0 +1,76 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AlertCondition( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Alert trigger condition. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + ComparisonWrapper, + RangeWrapper, + RelativeWrapper, + AnomalyDetectionWrapper, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AlertCondition': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.anomaly_detection_wrapper import AnomalyDetectionWrapper +from gooddata_api_client.model.comparison_wrapper import ComparisonWrapper +from gooddata_api_client.model.range_wrapper import RangeWrapper +from gooddata_api_client.model.relative_wrapper import RelativeWrapper diff --git a/gooddata-api-client/gooddata_api_client/model/alert_condition_operand.pyi b/gooddata-api-client/gooddata_api_client/model/alert_condition_operand.pyi new file mode 100644 index 000000000..e7bb1ee7b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/alert_condition_operand.pyi @@ -0,0 +1,72 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AlertConditionOperand( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Operand of the alert condition. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + LocalIdentifier, + Value, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AlertConditionOperand': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.local_identifier import LocalIdentifier +from gooddata_api_client.model.value import Value diff --git a/gooddata-api-client/gooddata_api_client/model/alert_description.pyi b/gooddata-api-client/gooddata_api_client/model/alert_description.pyi new file mode 100644 index 000000000..000b92e2e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/alert_description.pyi @@ -0,0 +1,274 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AlertDescription( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "condition", + "metric", + } + + class properties: + condition = schemas.StrSchema + metric = schemas.StrSchema + attribute = schemas.StrSchema + + + class currentValues( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AlertEvaluationRow']: + return AlertEvaluationRow + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AlertEvaluationRow'], typing.List['AlertEvaluationRow']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'currentValues': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AlertEvaluationRow': + return super().__getitem__(i) + errorMessage = schemas.StrSchema + formattedThreshold = schemas.StrSchema + lowerThreshold = schemas.Float64Schema + remainingAlertEvaluationCount = schemas.Int32Schema + + + class status( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SUCCESS(cls): + return cls("SUCCESS") + + @schemas.classproperty + def ERROR(cls): + return cls("ERROR") + + @schemas.classproperty + def INTERNAL_ERROR(cls): + return cls("INTERNAL_ERROR") + + @schemas.classproperty + def TIMEOUT(cls): + return cls("TIMEOUT") + threshold = schemas.Float64Schema + totalValueCount = schemas.Int32Schema + traceId = schemas.StrSchema + triggeredAt = schemas.DateTimeSchema + triggeredCount = schemas.Int32Schema + upperThreshold = schemas.Float64Schema + __annotations__ = { + "condition": condition, + "metric": metric, + "attribute": attribute, + "currentValues": currentValues, + "errorMessage": errorMessage, + "formattedThreshold": formattedThreshold, + "lowerThreshold": lowerThreshold, + "remainingAlertEvaluationCount": remainingAlertEvaluationCount, + "status": status, + "threshold": threshold, + "totalValueCount": totalValueCount, + "traceId": traceId, + "triggeredAt": triggeredAt, + "triggeredCount": triggeredCount, + "upperThreshold": upperThreshold, + } + + condition: MetaOapg.properties.condition + metric: MetaOapg.properties.metric + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["condition"]) -> MetaOapg.properties.condition: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metric"]) -> MetaOapg.properties.metric: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attribute"]) -> MetaOapg.properties.attribute: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["currentValues"]) -> MetaOapg.properties.currentValues: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["errorMessage"]) -> MetaOapg.properties.errorMessage: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["formattedThreshold"]) -> MetaOapg.properties.formattedThreshold: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["lowerThreshold"]) -> MetaOapg.properties.lowerThreshold: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["remainingAlertEvaluationCount"]) -> MetaOapg.properties.remainingAlertEvaluationCount: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["threshold"]) -> MetaOapg.properties.threshold: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["totalValueCount"]) -> MetaOapg.properties.totalValueCount: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["traceId"]) -> MetaOapg.properties.traceId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["triggeredAt"]) -> MetaOapg.properties.triggeredAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["triggeredCount"]) -> MetaOapg.properties.triggeredCount: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["upperThreshold"]) -> MetaOapg.properties.upperThreshold: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["condition", "metric", "attribute", "currentValues", "errorMessage", "formattedThreshold", "lowerThreshold", "remainingAlertEvaluationCount", "status", "threshold", "totalValueCount", "traceId", "triggeredAt", "triggeredCount", "upperThreshold", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["condition"]) -> MetaOapg.properties.condition: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metric"]) -> MetaOapg.properties.metric: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attribute"]) -> typing.Union[MetaOapg.properties.attribute, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["currentValues"]) -> typing.Union[MetaOapg.properties.currentValues, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["errorMessage"]) -> typing.Union[MetaOapg.properties.errorMessage, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["formattedThreshold"]) -> typing.Union[MetaOapg.properties.formattedThreshold, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["lowerThreshold"]) -> typing.Union[MetaOapg.properties.lowerThreshold, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["remainingAlertEvaluationCount"]) -> typing.Union[MetaOapg.properties.remainingAlertEvaluationCount, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["status"]) -> typing.Union[MetaOapg.properties.status, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["threshold"]) -> typing.Union[MetaOapg.properties.threshold, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["totalValueCount"]) -> typing.Union[MetaOapg.properties.totalValueCount, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["traceId"]) -> typing.Union[MetaOapg.properties.traceId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["triggeredAt"]) -> typing.Union[MetaOapg.properties.triggeredAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["triggeredCount"]) -> typing.Union[MetaOapg.properties.triggeredCount, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["upperThreshold"]) -> typing.Union[MetaOapg.properties.upperThreshold, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["condition", "metric", "attribute", "currentValues", "errorMessage", "formattedThreshold", "lowerThreshold", "remainingAlertEvaluationCount", "status", "threshold", "totalValueCount", "traceId", "triggeredAt", "triggeredCount", "upperThreshold", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + condition: typing.Union[MetaOapg.properties.condition, str, ], + metric: typing.Union[MetaOapg.properties.metric, str, ], + attribute: typing.Union[MetaOapg.properties.attribute, str, schemas.Unset] = schemas.unset, + currentValues: typing.Union[MetaOapg.properties.currentValues, list, tuple, schemas.Unset] = schemas.unset, + errorMessage: typing.Union[MetaOapg.properties.errorMessage, str, schemas.Unset] = schemas.unset, + formattedThreshold: typing.Union[MetaOapg.properties.formattedThreshold, str, schemas.Unset] = schemas.unset, + lowerThreshold: typing.Union[MetaOapg.properties.lowerThreshold, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + remainingAlertEvaluationCount: typing.Union[MetaOapg.properties.remainingAlertEvaluationCount, decimal.Decimal, int, schemas.Unset] = schemas.unset, + status: typing.Union[MetaOapg.properties.status, str, schemas.Unset] = schemas.unset, + threshold: typing.Union[MetaOapg.properties.threshold, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + totalValueCount: typing.Union[MetaOapg.properties.totalValueCount, decimal.Decimal, int, schemas.Unset] = schemas.unset, + traceId: typing.Union[MetaOapg.properties.traceId, str, schemas.Unset] = schemas.unset, + triggeredAt: typing.Union[MetaOapg.properties.triggeredAt, str, datetime, schemas.Unset] = schemas.unset, + triggeredCount: typing.Union[MetaOapg.properties.triggeredCount, decimal.Decimal, int, schemas.Unset] = schemas.unset, + upperThreshold: typing.Union[MetaOapg.properties.upperThreshold, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AlertDescription': + return super().__new__( + cls, + *_args, + condition=condition, + metric=metric, + attribute=attribute, + currentValues=currentValues, + errorMessage=errorMessage, + formattedThreshold=formattedThreshold, + lowerThreshold=lowerThreshold, + remainingAlertEvaluationCount=remainingAlertEvaluationCount, + status=status, + threshold=threshold, + totalValueCount=totalValueCount, + traceId=traceId, + triggeredAt=triggeredAt, + triggeredCount=triggeredCount, + upperThreshold=upperThreshold, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.alert_evaluation_row import AlertEvaluationRow diff --git a/gooddata-api-client/gooddata_api_client/model/alert_evaluation_row.pyi b/gooddata-api-client/gooddata_api_client/model/alert_evaluation_row.pyi new file mode 100644 index 000000000..f8349839a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/alert_evaluation_row.pyi @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AlertEvaluationRow( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + @staticmethod + def computedMetric() -> typing.Type['MetricRecord']: + return MetricRecord + labelValue = schemas.StrSchema + + @staticmethod + def primaryMetric() -> typing.Type['MetricRecord']: + return MetricRecord + + @staticmethod + def secondaryMetric() -> typing.Type['MetricRecord']: + return MetricRecord + __annotations__ = { + "computedMetric": computedMetric, + "labelValue": labelValue, + "primaryMetric": primaryMetric, + "secondaryMetric": secondaryMetric, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["computedMetric"]) -> 'MetricRecord': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["labelValue"]) -> MetaOapg.properties.labelValue: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["primaryMetric"]) -> 'MetricRecord': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["secondaryMetric"]) -> 'MetricRecord': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["computedMetric", "labelValue", "primaryMetric", "secondaryMetric", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["computedMetric"]) -> typing.Union['MetricRecord', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["labelValue"]) -> typing.Union[MetaOapg.properties.labelValue, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["primaryMetric"]) -> typing.Union['MetricRecord', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["secondaryMetric"]) -> typing.Union['MetricRecord', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["computedMetric", "labelValue", "primaryMetric", "secondaryMetric", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + computedMetric: typing.Union['MetricRecord', schemas.Unset] = schemas.unset, + labelValue: typing.Union[MetaOapg.properties.labelValue, str, schemas.Unset] = schemas.unset, + primaryMetric: typing.Union['MetricRecord', schemas.Unset] = schemas.unset, + secondaryMetric: typing.Union['MetricRecord', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AlertEvaluationRow': + return super().__new__( + cls, + *_args, + computedMetric=computedMetric, + labelValue=labelValue, + primaryMetric=primaryMetric, + secondaryMetric=secondaryMetric, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.metric_record import MetricRecord diff --git a/gooddata-api-client/gooddata_api_client/model/all_time_date_filter.py b/gooddata-api-client/gooddata_api_client/model/all_time_date_filter.py index 16c0cf4de..fda9edc8f 100644 --- a/gooddata-api-client/gooddata_api_client/model/all_time_date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/all_time_date_filter.py @@ -25,15 +25,14 @@ file_type, none_type, validate_get_composed_info, - OpenApiModel, + OpenApiModel ) from gooddata_api_client.exceptions import ApiAttributeError def lazy_import(): from gooddata_api_client.model.all_time_date_filter_all_time_date_filter import AllTimeDateFilterAllTimeDateFilter - - globals()["AllTimeDateFilterAllTimeDateFilter"] = AllTimeDateFilterAllTimeDateFilter + globals()['AllTimeDateFilterAllTimeDateFilter'] = AllTimeDateFilterAllTimeDateFilter class AllTimeDateFilter(ModelNormal): @@ -60,8 +59,11 @@ class AllTimeDateFilter(ModelNormal): as additional properties values. """ - allowed_values = {} - validations = {} + allowed_values = { + } + + validations = { + } @cached_property def additional_properties_type(): @@ -70,7 +72,7 @@ def additional_properties_type(): of type self, this must run after the class is loaded """ lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type) # noqa: E501 + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -86,18 +88,20 @@ def openapi_types(): """ lazy_import() return { - "all_time_date_filter": (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 + 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 } @cached_property def discriminator(): return None + attribute_map = { - "all_time_date_filter": "allTimeDateFilter", # noqa: E501 + 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 } - read_only_vars = {} + read_only_vars = { + } _composed_schemas = {} @@ -142,11 +146,11 @@ def _from_openapi_data(cls, all_time_date_filter, *args, **kwargs): # noqa: E50 _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", ()) + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) self = super(OpenApiModel, cls).__new__(cls) @@ -156,8 +160,7 @@ def _from_openapi_data(cls, all_time_date_filter, *args, **kwargs): # noqa: E50 kwargs.update(arg) else: raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." - % ( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( args, self.__class__.__name__, ), @@ -174,25 +177,23 @@ def _from_openapi_data(cls, all_time_date_filter, *args, **kwargs): # noqa: E50 self.all_time_date_filter = all_time_date_filter for var_name, var_value in kwargs.items(): - if ( - var_name not in self.attribute_map - and self._configuration is not None - and self._configuration.discard_unknown_keys - and self.additional_properties_type is None - ): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: # discard variable. continue setattr(self, var_name, var_value) return self - required_properties = { - "_data_store", - "_check_type", - "_spec_property_naming", - "_path_to_item", - "_configuration", - "_visited_composed_classes", - } + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) @convert_js_args_to_python_args def __init__(self, all_time_date_filter, *args, **kwargs): # noqa: E501 @@ -234,11 +235,11 @@ def __init__(self, all_time_date_filter, *args, **kwargs): # noqa: E501 _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", ()) + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) if args: for arg in args: @@ -246,8 +247,7 @@ def __init__(self, all_time_date_filter, *args, **kwargs): # noqa: E501 kwargs.update(arg) else: raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." - % ( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( args, self.__class__.__name__, ), @@ -264,18 +264,13 @@ def __init__(self, all_time_date_filter, *args, **kwargs): # noqa: E501 self.all_time_date_filter = all_time_date_filter for var_name, var_value in kwargs.items(): - if ( - var_name not in self.attribute_map - and self._configuration is not None - and self._configuration.discard_unknown_keys - and self.additional_properties_type is None - ): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: # discard variable. continue setattr(self, var_name, var_value) if var_name in self.read_only_vars: - raise ApiAttributeError( - f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes." - ) - + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/all_time_date_filter.pyi b/gooddata-api-client/gooddata_api_client/model/all_time_date_filter.pyi new file mode 100644 index 000000000..4b6d6970e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/all_time_date_filter.pyi @@ -0,0 +1,283 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AllTimeDateFilter( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + An all-time date filter that does not restrict by date range. Controls how rows with empty (null/missing) date values are handled. + """ + + + class MetaOapg: + required = { + "allTimeDateFilter", + } + + class properties: + + + class allTimeDateFilter( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "dataset", + } + + class properties: + applyOnResult = schemas.BoolSchema + + @staticmethod + def dataset() -> typing.Type['AfmObjectIdentifierDataset']: + return AfmObjectIdentifierDataset + + + class emptyValueHandling( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INCLUDE(cls): + return cls("INCLUDE") + + @schemas.classproperty + def EXCLUDE(cls): + return cls("EXCLUDE") + + @schemas.classproperty + def ONLY(cls): + return cls("ONLY") + + + class granularity( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MINUTE(cls): + return cls("MINUTE") + + @schemas.classproperty + def HOUR(cls): + return cls("HOUR") + + @schemas.classproperty + def DAY(cls): + return cls("DAY") + + @schemas.classproperty + def WEEK(cls): + return cls("WEEK") + + @schemas.classproperty + def MONTH(cls): + return cls("MONTH") + + @schemas.classproperty + def QUARTER(cls): + return cls("QUARTER") + + @schemas.classproperty + def YEAR(cls): + return cls("YEAR") + + @schemas.classproperty + def MINUTE_OF_HOUR(cls): + return cls("MINUTE_OF_HOUR") + + @schemas.classproperty + def HOUR_OF_DAY(cls): + return cls("HOUR_OF_DAY") + + @schemas.classproperty + def DAY_OF_WEEK(cls): + return cls("DAY_OF_WEEK") + + @schemas.classproperty + def DAY_OF_MONTH(cls): + return cls("DAY_OF_MONTH") + + @schemas.classproperty + def DAY_OF_QUARTER(cls): + return cls("DAY_OF_QUARTER") + + @schemas.classproperty + def DAY_OF_YEAR(cls): + return cls("DAY_OF_YEAR") + + @schemas.classproperty + def WEEK_OF_YEAR(cls): + return cls("WEEK_OF_YEAR") + + @schemas.classproperty + def MONTH_OF_YEAR(cls): + return cls("MONTH_OF_YEAR") + + @schemas.classproperty + def QUARTER_OF_YEAR(cls): + return cls("QUARTER_OF_YEAR") + + @schemas.classproperty + def FISCAL_MONTH(cls): + return cls("FISCAL_MONTH") + + @schemas.classproperty + def FISCAL_QUARTER(cls): + return cls("FISCAL_QUARTER") + + @schemas.classproperty + def FISCAL_YEAR(cls): + return cls("FISCAL_YEAR") + localIdentifier = schemas.StrSchema + __annotations__ = { + "applyOnResult": applyOnResult, + "dataset": dataset, + "emptyValueHandling": emptyValueHandling, + "granularity": granularity, + "localIdentifier": localIdentifier, + } + + dataset: 'AfmObjectIdentifierDataset' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["applyOnResult"]) -> MetaOapg.properties.applyOnResult: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataset"]) -> 'AfmObjectIdentifierDataset': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["emptyValueHandling"]) -> MetaOapg.properties.emptyValueHandling: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "dataset", "emptyValueHandling", "granularity", "localIdentifier", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["applyOnResult"]) -> typing.Union[MetaOapg.properties.applyOnResult, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataset"]) -> 'AfmObjectIdentifierDataset': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["emptyValueHandling"]) -> typing.Union[MetaOapg.properties.emptyValueHandling, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["granularity"]) -> typing.Union[MetaOapg.properties.granularity, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["localIdentifier"]) -> typing.Union[MetaOapg.properties.localIdentifier, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "dataset", "emptyValueHandling", "granularity", "localIdentifier", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + dataset: 'AfmObjectIdentifierDataset', + applyOnResult: typing.Union[MetaOapg.properties.applyOnResult, bool, schemas.Unset] = schemas.unset, + emptyValueHandling: typing.Union[MetaOapg.properties.emptyValueHandling, str, schemas.Unset] = schemas.unset, + granularity: typing.Union[MetaOapg.properties.granularity, str, schemas.Unset] = schemas.unset, + localIdentifier: typing.Union[MetaOapg.properties.localIdentifier, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'allTimeDateFilter': + return super().__new__( + cls, + *_args, + dataset=dataset, + applyOnResult=applyOnResult, + emptyValueHandling=emptyValueHandling, + granularity=granularity, + localIdentifier=localIdentifier, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "allTimeDateFilter": allTimeDateFilter, + } + + allTimeDateFilter: MetaOapg.properties.allTimeDateFilter + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["allTimeDateFilter"]) -> MetaOapg.properties.allTimeDateFilter: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["allTimeDateFilter", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["allTimeDateFilter"]) -> MetaOapg.properties.allTimeDateFilter: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["allTimeDateFilter", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + allTimeDateFilter: typing.Union[MetaOapg.properties.allTimeDateFilter, dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AllTimeDateFilter': + return super().__new__( + cls, + *_args, + allTimeDateFilter=allTimeDateFilter, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.afm_object_identifier_dataset import AfmObjectIdentifierDataset diff --git a/gooddata-api-client/gooddata_api_client/model/all_time_date_filter_all_time_date_filter.py b/gooddata-api-client/gooddata_api_client/model/all_time_date_filter_all_time_date_filter.py index 71d4220fc..9b45c7a9c 100644 --- a/gooddata-api-client/gooddata_api_client/model/all_time_date_filter_all_time_date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/all_time_date_filter_all_time_date_filter.py @@ -25,15 +25,14 @@ file_type, none_type, validate_get_composed_info, - OpenApiModel, + OpenApiModel ) from gooddata_api_client.exceptions import ApiAttributeError def lazy_import(): from gooddata_api_client.model.afm_object_identifier_dataset import AfmObjectIdentifierDataset - - globals()["AfmObjectIdentifierDataset"] = AfmObjectIdentifierDataset + globals()['AfmObjectIdentifierDataset'] = AfmObjectIdentifierDataset class AllTimeDateFilterAllTimeDateFilter(ModelNormal): @@ -61,35 +60,36 @@ class AllTimeDateFilterAllTimeDateFilter(ModelNormal): """ allowed_values = { - ("empty_value_handling",): { - "INCLUDE": "INCLUDE", - "EXCLUDE": "EXCLUDE", - "ONLY": "ONLY", + ('empty_value_handling',): { + 'INCLUDE': "INCLUDE", + 'EXCLUDE': "EXCLUDE", + 'ONLY': "ONLY", }, - ("granularity",): { - "MINUTE": "MINUTE", - "HOUR": "HOUR", - "DAY": "DAY", - "WEEK": "WEEK", - "MONTH": "MONTH", - "QUARTER": "QUARTER", - "YEAR": "YEAR", - "MINUTE_OF_HOUR": "MINUTE_OF_HOUR", - "HOUR_OF_DAY": "HOUR_OF_DAY", - "DAY_OF_WEEK": "DAY_OF_WEEK", - "DAY_OF_MONTH": "DAY_OF_MONTH", - "DAY_OF_QUARTER": "DAY_OF_QUARTER", - "DAY_OF_YEAR": "DAY_OF_YEAR", - "WEEK_OF_YEAR": "WEEK_OF_YEAR", - "MONTH_OF_YEAR": "MONTH_OF_YEAR", - "QUARTER_OF_YEAR": "QUARTER_OF_YEAR", - "FISCAL_MONTH": "FISCAL_MONTH", - "FISCAL_QUARTER": "FISCAL_QUARTER", - "FISCAL_YEAR": "FISCAL_YEAR", + ('granularity',): { + 'MINUTE': "MINUTE", + 'HOUR': "HOUR", + 'DAY': "DAY", + 'WEEK': "WEEK", + 'MONTH': "MONTH", + 'QUARTER': "QUARTER", + 'YEAR': "YEAR", + 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", + 'HOUR_OF_DAY': "HOUR_OF_DAY", + 'DAY_OF_WEEK': "DAY_OF_WEEK", + 'DAY_OF_MONTH': "DAY_OF_MONTH", + 'DAY_OF_QUARTER': "DAY_OF_QUARTER", + 'DAY_OF_YEAR': "DAY_OF_YEAR", + 'WEEK_OF_YEAR': "WEEK_OF_YEAR", + 'MONTH_OF_YEAR': "MONTH_OF_YEAR", + 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", + 'FISCAL_MONTH': "FISCAL_MONTH", + 'FISCAL_QUARTER': "FISCAL_QUARTER", + 'FISCAL_YEAR': "FISCAL_YEAR", }, } - validations = {} + validations = { + } @cached_property def additional_properties_type(): @@ -98,7 +98,7 @@ def additional_properties_type(): of type self, this must run after the class is loaded """ lazy_import() - return (bool, date, datetime, dict, float, int, list, str, none_type) # noqa: E501 + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -114,26 +114,28 @@ def openapi_types(): """ lazy_import() return { - "dataset": (AfmObjectIdentifierDataset,), # noqa: E501 - "granularity": (str,), # noqa: E501 - "empty_value_handling": (str,), # noqa: E501 - "apply_on_result": (bool,), # noqa: E501 - "local_identifier": (str,), # noqa: E501 + 'dataset': (AfmObjectIdentifierDataset,), # noqa: E501 + 'apply_on_result': (bool,), # noqa: E501 + 'empty_value_handling': (str,), # noqa: E501 + 'granularity': (str,), # noqa: E501 + 'local_identifier': (str,), # noqa: E501 } @cached_property def discriminator(): return None + attribute_map = { - "dataset": "dataset", # noqa: E501 - "granularity": "granularity", # noqa: E501 - "empty_value_handling": "emptyValueHandling", # noqa: E501 - "apply_on_result": "applyOnResult", # noqa: E501 - "local_identifier": "localIdentifier", # noqa: E501 + 'dataset': 'dataset', # noqa: E501 + 'apply_on_result': 'applyOnResult', # noqa: E501 + 'empty_value_handling': 'emptyValueHandling', # noqa: E501 + 'granularity': 'granularity', # noqa: E501 + 'local_identifier': 'localIdentifier', # noqa: E501 } - read_only_vars = {} + read_only_vars = { + } _composed_schemas = {} @@ -165,17 +167,28 @@ def _from_openapi_data(cls, dataset, *args, **kwargs): # noqa: E501 classes that we have traveled through so that if we see that class again we will not use its discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) apply_on_result (bool): [optional] # noqa: E501 - empty_value_handling (str): [optional] # noqa: E501 - granularity (str): [optional] # noqa: E501 + empty_value_handling (str): Specifies how rows with empty (null/missing) date values should be handled. INCLUDE means no filtering effect (default), EXCLUDE removes rows with null dates, ONLY keeps only rows with null dates.. [optional] if omitted the server will use the default value of "INCLUDE" # noqa: E501 + granularity (str): Date granularity used to resolve the date attribute label for null value checks. Defaults to DAY if not specified.. [optional] if omitted the server will use the default value of "DAY" # noqa: E501 local_identifier (str): [optional] # noqa: E501 """ - _check_type = kwargs.pop("_check_type", True) - _spec_property_naming = kwargs.pop("_spec_property_naming", True) - _path_to_item = kwargs.pop("_path_to_item", ()) - _configuration = kwargs.pop("_configuration", None) - _visited_composed_classes = kwargs.pop("_visited_composed_classes", ()) + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) self = super(OpenApiModel, cls).__new__(cls) @@ -185,8 +198,7 @@ def _from_openapi_data(cls, dataset, *args, **kwargs): # noqa: E501 kwargs.update(arg) else: raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." - % ( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( args, self.__class__.__name__, ), @@ -203,25 +215,23 @@ def _from_openapi_data(cls, dataset, *args, **kwargs): # noqa: E501 self.dataset = dataset for var_name, var_value in kwargs.items(): - if ( - var_name not in self.attribute_map - and self._configuration is not None - and self._configuration.discard_unknown_keys - and self.additional_properties_type is None - ): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: # discard variable. continue setattr(self, var_name, var_value) return self - required_properties = { - "_data_store", - "_check_type", - "_spec_property_naming", - "_path_to_item", - "_configuration", - "_visited_composed_classes", - } + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) @convert_js_args_to_python_args def __init__(self, dataset, *args, **kwargs): # noqa: E501 @@ -250,17 +260,28 @@ def __init__(self, dataset, *args, **kwargs): # noqa: E501 classes that we have traveled through so that if we see that class again we will not use its discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) apply_on_result (bool): [optional] # noqa: E501 - empty_value_handling (str): [optional] # noqa: E501 - granularity (str): [optional] # noqa: E501 + empty_value_handling (str): Specifies how rows with empty (null/missing) date values should be handled. INCLUDE means no filtering effect (default), EXCLUDE removes rows with null dates, ONLY keeps only rows with null dates.. [optional] if omitted the server will use the default value of "INCLUDE" # noqa: E501 + granularity (str): Date granularity used to resolve the date attribute label for null value checks. Defaults to DAY if not specified.. [optional] if omitted the server will use the default value of "DAY" # noqa: E501 local_identifier (str): [optional] # noqa: E501 """ - _check_type = kwargs.pop("_check_type", True) - _spec_property_naming = kwargs.pop("_spec_property_naming", False) - _path_to_item = kwargs.pop("_path_to_item", ()) - _configuration = kwargs.pop("_configuration", None) - _visited_composed_classes = kwargs.pop("_visited_composed_classes", ()) + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) if args: for arg in args: @@ -268,8 +289,7 @@ def __init__(self, dataset, *args, **kwargs): # noqa: E501 kwargs.update(arg) else: raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." - % ( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( args, self.__class__.__name__, ), @@ -286,18 +306,13 @@ def __init__(self, dataset, *args, **kwargs): # noqa: E501 self.dataset = dataset for var_name, var_value in kwargs.items(): - if ( - var_name not in self.attribute_map - and self._configuration is not None - and self._configuration.discard_unknown_keys - and self.additional_properties_type is None - ): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: # discard variable. continue setattr(self, var_name, var_value) if var_name in self.read_only_vars: - raise ApiAttributeError( - f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes." - ) - + raise ApiAttributeError(f"`{var_name}` is a read-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.pyi b/gooddata-api-client/gooddata_api_client/model/allowed_relationship_type.pyi new file mode 100644 index 000000000..b1230b3b8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/allowed_relationship_type.pyi @@ -0,0 +1,182 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AllowedRelationshipType( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Allowed relationship type combination. + """ + + + class MetaOapg: + required = { + "sourceType", + "targetType", + } + + class properties: + + + class sourceType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ATTRIBUTE(cls): + return cls("attribute") + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def FACT(cls): + return cls("fact") + + @schemas.classproperty + def LABEL(cls): + return cls("label") + + @schemas.classproperty + def DATE(cls): + return cls("date") + + @schemas.classproperty + def DATASET(cls): + return cls("dataset") + + @schemas.classproperty + def VISUALIZATION(cls): + return cls("visualization") + + @schemas.classproperty + def DASHBOARD(cls): + return cls("dashboard") + + + class targetType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ATTRIBUTE(cls): + return cls("attribute") + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def FACT(cls): + return cls("fact") + + @schemas.classproperty + def LABEL(cls): + return cls("label") + + @schemas.classproperty + def DATE(cls): + return cls("date") + + @schemas.classproperty + def DATASET(cls): + return cls("dataset") + + @schemas.classproperty + def VISUALIZATION(cls): + return cls("visualization") + + @schemas.classproperty + def DASHBOARD(cls): + return cls("dashboard") + allowOrphans = schemas.BoolSchema + __annotations__ = { + "sourceType": sourceType, + "targetType": targetType, + "allowOrphans": allowOrphans, + } + + sourceType: MetaOapg.properties.sourceType + targetType: MetaOapg.properties.targetType + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sourceType"]) -> MetaOapg.properties.sourceType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["targetType"]) -> MetaOapg.properties.targetType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["allowOrphans"]) -> MetaOapg.properties.allowOrphans: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["sourceType", "targetType", "allowOrphans", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sourceType"]) -> MetaOapg.properties.sourceType: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["targetType"]) -> MetaOapg.properties.targetType: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["allowOrphans"]) -> typing.Union[MetaOapg.properties.allowOrphans, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["sourceType", "targetType", "allowOrphans", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + sourceType: typing.Union[MetaOapg.properties.sourceType, str, ], + targetType: typing.Union[MetaOapg.properties.targetType, str, ], + allowOrphans: typing.Union[MetaOapg.properties.allowOrphans, bool, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AllowedRelationshipType': + return super().__new__( + cls, + *_args, + sourceType=sourceType, + targetType=targetType, + allowOrphans=allowOrphans, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/analytics_catalog_created_by.pyi b/gooddata-api-client/gooddata_api_client/model/analytics_catalog_created_by.pyi new file mode 100644 index 000000000..e45a40266 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/analytics_catalog_created_by.pyi @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AnalyticsCatalogCreatedBy( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "reasoning", + "users", + } + + class properties: + reasoning = schemas.StrSchema + + + class users( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AnalyticsCatalogUser']: + return AnalyticsCatalogUser + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AnalyticsCatalogUser'], typing.List['AnalyticsCatalogUser']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'users': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AnalyticsCatalogUser': + return super().__getitem__(i) + __annotations__ = { + "reasoning": reasoning, + "users": users, + } + + reasoning: MetaOapg.properties.reasoning + users: MetaOapg.properties.users + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["reasoning"]) -> MetaOapg.properties.reasoning: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["reasoning", "users", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["reasoning"]) -> MetaOapg.properties.reasoning: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["reasoning", "users", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + reasoning: typing.Union[MetaOapg.properties.reasoning, str, ], + users: typing.Union[MetaOapg.properties.users, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AnalyticsCatalogCreatedBy': + return super().__new__( + cls, + *_args, + reasoning=reasoning, + users=users, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.analytics_catalog_user import AnalyticsCatalogUser diff --git a/gooddata-api-client/gooddata_api_client/model/analytics_catalog_tags.pyi b/gooddata-api-client/gooddata_api_client/model/analytics_catalog_tags.pyi new file mode 100644 index 000000000..0799ddc02 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/analytics_catalog_tags.pyi @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AnalyticsCatalogTags( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "tags", + } + + class properties: + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "tags": tags, + } + + tags: MetaOapg.properties.tags + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["tags", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["tags", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + tags: typing.Union[MetaOapg.properties.tags, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AnalyticsCatalogTags': + return super().__new__( + cls, + *_args, + tags=tags, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/analytics_catalog_user.pyi b/gooddata-api-client/gooddata_api_client/model/analytics_catalog_user.pyi new file mode 100644 index 000000000..d7eb05b72 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/analytics_catalog_user.pyi @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AnalyticsCatalogUser( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Users who created any object in the catalog + """ + + + class MetaOapg: + required = { + "firstname", + "userId", + "lastname", + } + + class properties: + firstname = schemas.StrSchema + lastname = schemas.StrSchema + userId = schemas.StrSchema + __annotations__ = { + "firstname": firstname, + "lastname": lastname, + "userId": userId, + } + + firstname: MetaOapg.properties.firstname + userId: MetaOapg.properties.userId + lastname: MetaOapg.properties.lastname + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["firstname"]) -> MetaOapg.properties.firstname: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["lastname"]) -> MetaOapg.properties.lastname: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["userId"]) -> MetaOapg.properties.userId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["firstname", "lastname", "userId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["firstname"]) -> MetaOapg.properties.firstname: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["lastname"]) -> MetaOapg.properties.lastname: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["userId"]) -> MetaOapg.properties.userId: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["firstname", "lastname", "userId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + firstname: typing.Union[MetaOapg.properties.firstname, str, ], + userId: typing.Union[MetaOapg.properties.userId, str, ], + lastname: typing.Union[MetaOapg.properties.lastname, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AnalyticsCatalogUser': + return super().__new__( + cls, + *_args, + firstname=firstname, + userId=userId, + lastname=lastname, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/anomaly_detection.pyi b/gooddata-api-client/gooddata_api_client/model/anomaly_detection.pyi new file mode 100644 index 000000000..8b7220ae0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/anomaly_detection.pyi @@ -0,0 +1,175 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AnomalyDetection( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "measure", + "granularity", + "sensitivity", + "dataset", + } + + class properties: + + @staticmethod + def dataset() -> typing.Type['AfmObjectIdentifierDataset']: + return AfmObjectIdentifierDataset + + + class granularity( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def HOUR(cls): + return cls("HOUR") + + @schemas.classproperty + def DAY(cls): + return cls("DAY") + + @schemas.classproperty + def WEEK(cls): + return cls("WEEK") + + @schemas.classproperty + def MONTH(cls): + return cls("MONTH") + + @schemas.classproperty + def QUARTER(cls): + return cls("QUARTER") + + @schemas.classproperty + def YEAR(cls): + return cls("YEAR") + + @staticmethod + def measure() -> typing.Type['LocalIdentifier']: + return LocalIdentifier + + + class sensitivity( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def LOW(cls): + return cls("LOW") + + @schemas.classproperty + def MEDIUM(cls): + return cls("MEDIUM") + + @schemas.classproperty + def HIGH(cls): + return cls("HIGH") + __annotations__ = { + "dataset": dataset, + "granularity": granularity, + "measure": measure, + "sensitivity": sensitivity, + } + + measure: 'LocalIdentifier' + granularity: MetaOapg.properties.granularity + sensitivity: MetaOapg.properties.sensitivity + dataset: 'AfmObjectIdentifierDataset' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataset"]) -> 'AfmObjectIdentifierDataset': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["measure"]) -> 'LocalIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sensitivity"]) -> MetaOapg.properties.sensitivity: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataset", "granularity", "measure", "sensitivity", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataset"]) -> 'AfmObjectIdentifierDataset': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["measure"]) -> 'LocalIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sensitivity"]) -> MetaOapg.properties.sensitivity: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataset", "granularity", "measure", "sensitivity", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + measure: 'LocalIdentifier', + granularity: typing.Union[MetaOapg.properties.granularity, str, ], + sensitivity: typing.Union[MetaOapg.properties.sensitivity, str, ], + dataset: 'AfmObjectIdentifierDataset', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AnomalyDetection': + return super().__new__( + cls, + *_args, + measure=measure, + granularity=granularity, + sensitivity=sensitivity, + dataset=dataset, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.afm_object_identifier_dataset import AfmObjectIdentifierDataset +from gooddata_api_client.model.local_identifier import LocalIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/anomaly_detection_config.py b/gooddata-api-client/gooddata_api_client/model/anomaly_detection_config.py new file mode 100644 index 000000000..40d6f718b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/anomaly_detection_config.py @@ -0,0 +1,275 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class AnomalyDetectionConfig(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('sensitivity',): { + 'LOW': "LOW", + 'MEDIUM': "MEDIUM", + 'HIGH': "HIGH", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'sensitivity': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'sensitivity': 'sensitivity', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, sensitivity, *args, **kwargs): # noqa: E501 + """AnomalyDetectionConfig - a model defined in OpenAPI + + Args: + sensitivity (str): Outlier sensitivity level. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.sensitivity = sensitivity + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, sensitivity, *args, **kwargs): # noqa: E501 + """AnomalyDetectionConfig - a model defined in OpenAPI + + Args: + sensitivity (str): Outlier sensitivity level. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.sensitivity = sensitivity + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/anomaly_detection_config.pyi b/gooddata-api-client/gooddata_api_client/model/anomaly_detection_config.pyi new file mode 100644 index 000000000..5d1aa1315 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/anomaly_detection_config.pyi @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AnomalyDetectionConfig( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Anomaly detection configuration. + """ + + + class MetaOapg: + required = { + "sensitivity", + } + + class properties: + + + class sensitivity( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def LOW(cls): + return cls("LOW") + + @schemas.classproperty + def MEDIUM(cls): + return cls("MEDIUM") + + @schemas.classproperty + def HIGH(cls): + return cls("HIGH") + __annotations__ = { + "sensitivity": sensitivity, + } + + sensitivity: MetaOapg.properties.sensitivity + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sensitivity"]) -> MetaOapg.properties.sensitivity: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["sensitivity", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sensitivity"]) -> MetaOapg.properties.sensitivity: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["sensitivity", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + sensitivity: typing.Union[MetaOapg.properties.sensitivity, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AnomalyDetectionConfig': + return super().__new__( + cls, + *_args, + sensitivity=sensitivity, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/anomaly_detection_request.pyi b/gooddata-api-client/gooddata_api_client/model/anomaly_detection_request.pyi new file mode 100644 index 000000000..f224705b7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/anomaly_detection_request.pyi @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AnomalyDetectionRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "sensitivity", + } + + class properties: + sensitivity = schemas.Float32Schema + __annotations__ = { + "sensitivity": sensitivity, + } + + sensitivity: MetaOapg.properties.sensitivity + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sensitivity"]) -> MetaOapg.properties.sensitivity: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["sensitivity", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sensitivity"]) -> MetaOapg.properties.sensitivity: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["sensitivity", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + sensitivity: typing.Union[MetaOapg.properties.sensitivity, decimal.Decimal, int, float, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AnomalyDetectionRequest': + return super().__new__( + cls, + *_args, + sensitivity=sensitivity, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/anomaly_detection_result.pyi b/gooddata-api-client/gooddata_api_client/model/anomaly_detection_result.pyi new file mode 100644 index 000000000..c9513bdc3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/anomaly_detection_result.pyi @@ -0,0 +1,212 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AnomalyDetectionResult( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "values", + "anomalyFlag", + "attribute", + } + + class properties: + + + class anomalyFlag( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.BoolBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneBoolMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, bool, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, None, bool, ]], typing.List[typing.Union[MetaOapg.items, None, bool, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'anomalyFlag': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class attribute( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attribute': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class values( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.NumberBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneDecimalMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, decimal.Decimal, int, float, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, None, decimal.Decimal, int, float, ]], typing.List[typing.Union[MetaOapg.items, None, decimal.Decimal, int, float, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'values': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "anomalyFlag": anomalyFlag, + "attribute": attribute, + "values": values, + } + + values: MetaOapg.properties.values + anomalyFlag: MetaOapg.properties.anomalyFlag + attribute: MetaOapg.properties.attribute + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["anomalyFlag"]) -> MetaOapg.properties.anomalyFlag: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attribute"]) -> MetaOapg.properties.attribute: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["values"]) -> MetaOapg.properties.values: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["anomalyFlag", "attribute", "values", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["anomalyFlag"]) -> MetaOapg.properties.anomalyFlag: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attribute"]) -> MetaOapg.properties.attribute: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["values"]) -> MetaOapg.properties.values: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["anomalyFlag", "attribute", "values", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + values: typing.Union[MetaOapg.properties.values, list, tuple, ], + anomalyFlag: typing.Union[MetaOapg.properties.anomalyFlag, list, tuple, ], + attribute: typing.Union[MetaOapg.properties.attribute, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AnomalyDetectionResult': + return super().__new__( + cls, + *_args, + values=values, + anomalyFlag=anomalyFlag, + attribute=attribute, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/anomaly_detection_wrapper.pyi b/gooddata-api-client/gooddata_api_client/model/anomaly_detection_wrapper.pyi new file mode 100644 index 000000000..7fd92766c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/anomaly_detection_wrapper.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AnomalyDetectionWrapper( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "anomaly", + } + + class properties: + + @staticmethod + def anomaly() -> typing.Type['AnomalyDetection']: + return AnomalyDetection + __annotations__ = { + "anomaly": anomaly, + } + + anomaly: 'AnomalyDetection' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["anomaly"]) -> 'AnomalyDetection': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["anomaly", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["anomaly"]) -> 'AnomalyDetection': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["anomaly", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + anomaly: 'AnomalyDetection', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AnomalyDetectionWrapper': + return super().__new__( + cls, + *_args, + anomaly=anomaly, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.anomaly_detection import AnomalyDetection diff --git a/gooddata-api-client/gooddata_api_client/model/arithmetic_measure.pyi b/gooddata-api-client/gooddata_api_client/model/arithmetic_measure.pyi new file mode 100644 index 000000000..baf29fbd0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/arithmetic_measure.pyi @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ArithmeticMeasure( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "left", + "right", + "operator", + } + + class properties: + + @staticmethod + def left() -> typing.Type['LocalIdentifier']: + return LocalIdentifier + + + class operator( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DIFFERENCE(cls): + return cls("DIFFERENCE") + + @schemas.classproperty + def CHANGE(cls): + return cls("CHANGE") + + @staticmethod + def right() -> typing.Type['LocalIdentifier']: + return LocalIdentifier + __annotations__ = { + "left": left, + "operator": operator, + "right": right, + } + + left: 'LocalIdentifier' + right: 'LocalIdentifier' + operator: MetaOapg.properties.operator + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["left"]) -> 'LocalIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["right"]) -> 'LocalIdentifier': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["left", "operator", "right", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["left"]) -> 'LocalIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["right"]) -> 'LocalIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["left", "operator", "right", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + left: 'LocalIdentifier', + right: 'LocalIdentifier', + operator: typing.Union[MetaOapg.properties.operator, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ArithmeticMeasure': + return super().__new__( + cls, + *_args, + left=left, + right=right, + operator=operator, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.local_identifier import LocalIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/array.pyi b/gooddata-api-client/gooddata_api_client/model/array.pyi new file mode 100644 index 000000000..a69990842 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/array.pyi @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Array( + schemas.ListSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'Array': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) diff --git a/gooddata-api-client/gooddata_api_client/model/assignee_rule.pyi b/gooddata-api-client/gooddata_api_client/model/assignee_rule.pyi new file mode 100644 index 000000000..493f9a740 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/assignee_rule.pyi @@ -0,0 +1,95 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AssigneeRule( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Identifier of an assignee rule. + """ + + + class MetaOapg: + required = { + "type", + } + + class properties: + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ALL_WORKSPACE_USERS(cls): + return cls("allWorkspaceUsers") + __annotations__ = { + "type": type, + } + + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AssigneeRule': + return super().__new__( + cls, + *_args, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_elements.pyi b/gooddata-api-client/gooddata_api_client/model/attribute_elements.pyi new file mode 100644 index 000000000..111c5f099 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/attribute_elements.pyi @@ -0,0 +1,70 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AttributeElements( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AttributeElementsByRef, + AttributeElementsByValue, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AttributeElements': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.attribute_elements_by_ref import AttributeElementsByRef +from gooddata_api_client.model.attribute_elements_by_value import AttributeElementsByValue diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_elements_by_ref.pyi b/gooddata-api-client/gooddata_api_client/model/attribute_elements_by_ref.pyi new file mode 100644 index 000000000..4007f9d79 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/attribute_elements_by_ref.pyi @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AttributeElementsByRef( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "uris", + } + + class properties: + + + class uris( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, None, str, ]], typing.List[typing.Union[MetaOapg.items, None, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'uris': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "uris": uris, + } + + uris: MetaOapg.properties.uris + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["uris"]) -> MetaOapg.properties.uris: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["uris", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["uris"]) -> MetaOapg.properties.uris: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["uris", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + uris: typing.Union[MetaOapg.properties.uris, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AttributeElementsByRef': + return super().__new__( + cls, + *_args, + uris=uris, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_elements_by_value.pyi b/gooddata-api-client/gooddata_api_client/model/attribute_elements_by_value.pyi new file mode 100644 index 000000000..9916d18ca --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/attribute_elements_by_value.pyi @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AttributeElementsByValue( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "values", + } + + class properties: + + + class values( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, None, str, ]], typing.List[typing.Union[MetaOapg.items, None, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'values': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "values": values, + } + + values: MetaOapg.properties.values + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["values"]) -> MetaOapg.properties.values: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["values", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["values"]) -> MetaOapg.properties.values: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["values", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + values: typing.Union[MetaOapg.properties.values, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AttributeElementsByValue': + return super().__new__( + cls, + *_args, + values=values, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_filter_by_date.pyi b/gooddata-api-client/gooddata_api_client/model/attribute_filter_by_date.pyi new file mode 100644 index 000000000..c9b92e223 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/attribute_filter_by_date.pyi @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AttributeFilterByDate( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "filterLocalIdentifier", + "isCommonDate", + } + + class properties: + filterLocalIdentifier = schemas.StrSchema + isCommonDate = schemas.BoolSchema + __annotations__ = { + "filterLocalIdentifier": filterLocalIdentifier, + "isCommonDate": isCommonDate, + } + + filterLocalIdentifier: MetaOapg.properties.filterLocalIdentifier + isCommonDate: MetaOapg.properties.isCommonDate + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filterLocalIdentifier"]) -> MetaOapg.properties.filterLocalIdentifier: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isCommonDate"]) -> MetaOapg.properties.isCommonDate: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["filterLocalIdentifier", "isCommonDate", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filterLocalIdentifier"]) -> MetaOapg.properties.filterLocalIdentifier: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isCommonDate"]) -> MetaOapg.properties.isCommonDate: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["filterLocalIdentifier", "isCommonDate", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + filterLocalIdentifier: typing.Union[MetaOapg.properties.filterLocalIdentifier, str, ], + isCommonDate: typing.Union[MetaOapg.properties.isCommonDate, bool, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AttributeFilterByDate': + return super().__new__( + cls, + *_args, + filterLocalIdentifier=filterLocalIdentifier, + isCommonDate=isCommonDate, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_filter_parent.pyi b/gooddata-api-client/gooddata_api_client/model/attribute_filter_parent.pyi new file mode 100644 index 000000000..d1376a7b7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/attribute_filter_parent.pyi @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AttributeFilterParent( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "over", + "filterLocalIdentifier", + } + + class properties: + filterLocalIdentifier = schemas.StrSchema + + @staticmethod + def over() -> typing.Type['Over']: + return Over + __annotations__ = { + "filterLocalIdentifier": filterLocalIdentifier, + "over": over, + } + + over: 'Over' + filterLocalIdentifier: MetaOapg.properties.filterLocalIdentifier + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filterLocalIdentifier"]) -> MetaOapg.properties.filterLocalIdentifier: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["over"]) -> 'Over': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["filterLocalIdentifier", "over", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filterLocalIdentifier"]) -> MetaOapg.properties.filterLocalIdentifier: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["over"]) -> 'Over': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["filterLocalIdentifier", "over", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + over: 'Over', + filterLocalIdentifier: typing.Union[MetaOapg.properties.filterLocalIdentifier, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AttributeFilterParent': + return super().__new__( + cls, + *_args, + over=over, + filterLocalIdentifier=filterLocalIdentifier, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.over import Over diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_header.pyi b/gooddata-api-client/gooddata_api_client/model/attribute_header.pyi new file mode 100644 index 000000000..9a0553974 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/attribute_header.pyi @@ -0,0 +1,376 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AttributeHeader( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "attributeHeader", + } + + class properties: + + + class attributeHeader( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "primaryLabel", + "localIdentifier", + "attributeName", + "attribute", + "label", + "labelName", + } + + class properties: + + @staticmethod + def attribute() -> typing.Type['RestApiIdentifier']: + return RestApiIdentifier + attributeName = schemas.StrSchema + + @staticmethod + def format() -> typing.Type['AttributeFormat']: + return AttributeFormat + + @staticmethod + def geoAreaConfig() -> typing.Type['GeoAreaConfig']: + return GeoAreaConfig + + + class granularity( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MINUTE(cls): + return cls("MINUTE") + + @schemas.classproperty + def HOUR(cls): + return cls("HOUR") + + @schemas.classproperty + def DAY(cls): + return cls("DAY") + + @schemas.classproperty + def WEEK(cls): + return cls("WEEK") + + @schemas.classproperty + def MONTH(cls): + return cls("MONTH") + + @schemas.classproperty + def QUARTER(cls): + return cls("QUARTER") + + @schemas.classproperty + def YEAR(cls): + return cls("YEAR") + + @schemas.classproperty + def MINUTE_OF_HOUR(cls): + return cls("MINUTE_OF_HOUR") + + @schemas.classproperty + def HOUR_OF_DAY(cls): + return cls("HOUR_OF_DAY") + + @schemas.classproperty + def DAY_OF_WEEK(cls): + return cls("DAY_OF_WEEK") + + @schemas.classproperty + def DAY_OF_MONTH(cls): + return cls("DAY_OF_MONTH") + + @schemas.classproperty + def DAY_OF_QUARTER(cls): + return cls("DAY_OF_QUARTER") + + @schemas.classproperty + def DAY_OF_YEAR(cls): + return cls("DAY_OF_YEAR") + + @schemas.classproperty + def WEEK_OF_YEAR(cls): + return cls("WEEK_OF_YEAR") + + @schemas.classproperty + def MONTH_OF_YEAR(cls): + return cls("MONTH_OF_YEAR") + + @schemas.classproperty + def QUARTER_OF_YEAR(cls): + return cls("QUARTER_OF_YEAR") + + @schemas.classproperty + def FISCAL_MONTH(cls): + return cls("FISCAL_MONTH") + + @schemas.classproperty + def FISCAL_QUARTER(cls): + return cls("FISCAL_QUARTER") + + @schemas.classproperty + def FISCAL_YEAR(cls): + return cls("FISCAL_YEAR") + + @staticmethod + def label() -> typing.Type['RestApiIdentifier']: + return RestApiIdentifier + labelName = schemas.StrSchema + + + class localIdentifier( + schemas.StrSchema + ): + pass + + @staticmethod + def primaryLabel() -> typing.Type['RestApiIdentifier']: + return RestApiIdentifier + + + class valueType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def TEXT(cls): + return cls("TEXT") + + @schemas.classproperty + def HYPERLINK(cls): + return cls("HYPERLINK") + + @schemas.classproperty + def GEO(cls): + return cls("GEO") + + @schemas.classproperty + def GEO_LONGITUDE(cls): + return cls("GEO_LONGITUDE") + + @schemas.classproperty + def GEO_LATITUDE(cls): + return cls("GEO_LATITUDE") + + @schemas.classproperty + def GEO_AREA(cls): + return cls("GEO_AREA") + + @schemas.classproperty + def IMAGE(cls): + return cls("IMAGE") + __annotations__ = { + "attribute": attribute, + "attributeName": attributeName, + "format": format, + "geoAreaConfig": geoAreaConfig, + "granularity": granularity, + "label": label, + "labelName": labelName, + "localIdentifier": localIdentifier, + "primaryLabel": primaryLabel, + "valueType": valueType, + } + + primaryLabel: 'RestApiIdentifier' + localIdentifier: MetaOapg.properties.localIdentifier + attributeName: MetaOapg.properties.attributeName + attribute: 'RestApiIdentifier' + label: 'RestApiIdentifier' + labelName: MetaOapg.properties.labelName + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attribute"]) -> 'RestApiIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributeName"]) -> MetaOapg.properties.attributeName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["format"]) -> 'AttributeFormat': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["geoAreaConfig"]) -> 'GeoAreaConfig': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["label"]) -> 'RestApiIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["labelName"]) -> MetaOapg.properties.labelName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["primaryLabel"]) -> 'RestApiIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["valueType"]) -> MetaOapg.properties.valueType: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attribute", "attributeName", "format", "geoAreaConfig", "granularity", "label", "labelName", "localIdentifier", "primaryLabel", "valueType", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attribute"]) -> 'RestApiIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributeName"]) -> MetaOapg.properties.attributeName: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["format"]) -> typing.Union['AttributeFormat', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["geoAreaConfig"]) -> typing.Union['GeoAreaConfig', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["granularity"]) -> typing.Union[MetaOapg.properties.granularity, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["label"]) -> 'RestApiIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["labelName"]) -> MetaOapg.properties.labelName: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["primaryLabel"]) -> 'RestApiIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["valueType"]) -> typing.Union[MetaOapg.properties.valueType, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attribute", "attributeName", "format", "geoAreaConfig", "granularity", "label", "labelName", "localIdentifier", "primaryLabel", "valueType", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + primaryLabel: 'RestApiIdentifier', + localIdentifier: typing.Union[MetaOapg.properties.localIdentifier, str, ], + attributeName: typing.Union[MetaOapg.properties.attributeName, str, ], + attribute: 'RestApiIdentifier', + label: 'RestApiIdentifier', + labelName: typing.Union[MetaOapg.properties.labelName, str, ], + format: typing.Union['AttributeFormat', schemas.Unset] = schemas.unset, + geoAreaConfig: typing.Union['GeoAreaConfig', schemas.Unset] = schemas.unset, + granularity: typing.Union[MetaOapg.properties.granularity, str, schemas.Unset] = schemas.unset, + valueType: typing.Union[MetaOapg.properties.valueType, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributeHeader': + return super().__new__( + cls, + *_args, + primaryLabel=primaryLabel, + localIdentifier=localIdentifier, + attributeName=attributeName, + attribute=attribute, + label=label, + labelName=labelName, + format=format, + geoAreaConfig=geoAreaConfig, + granularity=granularity, + valueType=valueType, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "attributeHeader": attributeHeader, + } + + attributeHeader: MetaOapg.properties.attributeHeader + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributeHeader"]) -> MetaOapg.properties.attributeHeader: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributeHeader", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributeHeader"]) -> MetaOapg.properties.attributeHeader: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributeHeader", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributeHeader: typing.Union[MetaOapg.properties.attributeHeader, dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AttributeHeader': + return super().__new__( + cls, + *_args, + attributeHeader=attributeHeader, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.attribute_format import AttributeFormat +from gooddata_api_client.model.geo_area_config import GeoAreaConfig +from gooddata_api_client.model.rest_api_identifier import RestApiIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_negative_filter.pyi b/gooddata-api-client/gooddata_api_client/model/attribute_negative_filter.pyi new file mode 100644 index 000000000..d020fa78a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/attribute_negative_filter.pyi @@ -0,0 +1,158 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AttributeNegativeFilter( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "using", + "exclude", + } + + + class all_of_1( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class exclude( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'exclude': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + using = schemas.StrSchema + __annotations__ = { + "exclude": exclude, + "using": using, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["exclude"]) -> MetaOapg.properties.exclude: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["using"]) -> MetaOapg.properties.using: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["exclude", "using", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["exclude"]) -> typing.Union[MetaOapg.properties.exclude, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["using"]) -> typing.Union[MetaOapg.properties.using, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["exclude", "using", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + exclude: typing.Union[MetaOapg.properties.exclude, list, tuple, schemas.Unset] = schemas.unset, + using: typing.Union[MetaOapg.properties.using, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + exclude=exclude, + using=using, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + Filter, + cls.all_of_1, + ] + + + using: schemas.AnyTypeSchema + exclude: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AttributeNegativeFilter': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.filter import Filter diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_positive_filter.pyi b/gooddata-api-client/gooddata_api_client/model/attribute_positive_filter.pyi new file mode 100644 index 000000000..ad47eea56 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/attribute_positive_filter.pyi @@ -0,0 +1,158 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AttributePositiveFilter( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "include", + "using", + } + + + class all_of_1( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class include( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'include': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + using = schemas.StrSchema + __annotations__ = { + "include": include, + "using": using, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["include"]) -> MetaOapg.properties.include: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["using"]) -> MetaOapg.properties.using: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["include", "using", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["include"]) -> typing.Union[MetaOapg.properties.include, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["using"]) -> typing.Union[MetaOapg.properties.using, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["include", "using", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + include: typing.Union[MetaOapg.properties.include, list, tuple, schemas.Unset] = schemas.unset, + using: typing.Union[MetaOapg.properties.using, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + include=include, + using=using, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + Filter, + cls.all_of_1, + ] + + + include: schemas.AnyTypeSchema + using: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AttributePositiveFilter': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.filter import Filter diff --git a/gooddata-api-client/gooddata_api_client/model/automation_alert.pyi b/gooddata-api-client/gooddata_api_client/model/automation_alert.pyi new file mode 100644 index 000000000..0dcd3c338 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/automation_alert.pyi @@ -0,0 +1,205 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AutomationAlert( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "execution", + "condition", + } + + class properties: + + + class condition( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AnomalyDetectionWrapper, + ComparisonWrapper, + RangeWrapper, + RelativeWrapper, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'condition': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @staticmethod + def execution() -> typing.Type['AlertAfm']: + return AlertAfm + + + class interval( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DAY(cls): + return cls("DAY") + + @schemas.classproperty + def WEEK(cls): + return cls("WEEK") + + @schemas.classproperty + def MONTH(cls): + return cls("MONTH") + + @schemas.classproperty + def QUARTER(cls): + return cls("QUARTER") + + @schemas.classproperty + def YEAR(cls): + return cls("YEAR") + + + class trigger( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ALWAYS(cls): + return cls("ALWAYS") + + @schemas.classproperty + def ONCE(cls): + return cls("ONCE") + + @schemas.classproperty + def ONCE_PER_INTERVAL(cls): + return cls("ONCE_PER_INTERVAL") + __annotations__ = { + "condition": condition, + "execution": execution, + "interval": interval, + "trigger": trigger, + } + + execution: 'AlertAfm' + condition: MetaOapg.properties.condition + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["condition"]) -> MetaOapg.properties.condition: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["execution"]) -> 'AlertAfm': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["interval"]) -> MetaOapg.properties.interval: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["trigger"]) -> MetaOapg.properties.trigger: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["condition", "execution", "interval", "trigger", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["condition"]) -> MetaOapg.properties.condition: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["execution"]) -> 'AlertAfm': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["interval"]) -> typing.Union[MetaOapg.properties.interval, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["trigger"]) -> typing.Union[MetaOapg.properties.trigger, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["condition", "execution", "interval", "trigger", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + execution: 'AlertAfm', + condition: typing.Union[MetaOapg.properties.condition, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + interval: typing.Union[MetaOapg.properties.interval, str, schemas.Unset] = schemas.unset, + trigger: typing.Union[MetaOapg.properties.trigger, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AutomationAlert': + return super().__new__( + cls, + *_args, + execution=execution, + condition=condition, + interval=interval, + trigger=trigger, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.alert_afm import AlertAfm +from gooddata_api_client.model.anomaly_detection_wrapper import AnomalyDetectionWrapper +from gooddata_api_client.model.comparison_wrapper import ComparisonWrapper +from gooddata_api_client.model.range_wrapper import RangeWrapper +from gooddata_api_client.model.relative_wrapper import RelativeWrapper diff --git a/gooddata-api-client/gooddata_api_client/model/automation_dashboard_tabular_export.pyi b/gooddata-api-client/gooddata_api_client/model/automation_dashboard_tabular_export.pyi new file mode 100644 index 000000000..cee639e3c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/automation_dashboard_tabular_export.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AutomationDashboardTabularExport( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['DashboardTabularExportRequestV2']: + return DashboardTabularExportRequestV2 + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'DashboardTabularExportRequestV2' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'DashboardTabularExportRequestV2': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'DashboardTabularExportRequestV2': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'DashboardTabularExportRequestV2', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AutomationDashboardTabularExport': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.dashboard_tabular_export_request_v2 import DashboardTabularExportRequestV2 diff --git a/gooddata-api-client/gooddata_api_client/model/automation_external_recipient.pyi b/gooddata-api-client/gooddata_api_client/model/automation_external_recipient.pyi new file mode 100644 index 000000000..84db0e058 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/automation_external_recipient.pyi @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AutomationExternalRecipient( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "email", + } + + class properties: + email = schemas.StrSchema + __annotations__ = { + "email": email, + } + + email: MetaOapg.properties.email + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["email", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["email", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + email: typing.Union[MetaOapg.properties.email, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AutomationExternalRecipient': + return super().__new__( + cls, + *_args, + email=email, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/automation_image_export.pyi b/gooddata-api-client/gooddata_api_client/model/automation_image_export.pyi new file mode 100644 index 000000000..4dadc6a6b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/automation_image_export.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AutomationImageExport( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['ImageExportRequest']: + return ImageExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'ImageExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'ImageExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'ImageExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'ImageExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AutomationImageExport': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.image_export_request import ImageExportRequest diff --git a/gooddata-api-client/gooddata_api_client/model/automation_metadata.pyi b/gooddata-api-client/gooddata_api_client/model/automation_metadata.pyi new file mode 100644 index 000000000..78668c714 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/automation_metadata.pyi @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AutomationMetadata( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Additional information for the automation. + """ + + + class MetaOapg: + + class properties: + + + class visibleFilters( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['VisibleFilter']: + return VisibleFilter + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['VisibleFilter'], typing.List['VisibleFilter']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visibleFilters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'VisibleFilter': + return super().__getitem__(i) + widget = schemas.StrSchema + __annotations__ = { + "visibleFilters": visibleFilters, + "widget": widget, + } + additional_properties = schemas.AnyTypeSchema + + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visibleFilters"]) -> MetaOapg.properties.visibleFilters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widget"]) -> MetaOapg.properties.widget: ... + + @typing.overload + def __getitem__(self, name: str) -> MetaOapg.additional_properties: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["visibleFilters"], typing_extensions.Literal["widget"], str, ]): + # dict_instance[name] accessor + return super().__getitem__(name) + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visibleFilters"]) -> typing.Union[MetaOapg.properties.visibleFilters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widget"]) -> typing.Union[MetaOapg.properties.widget, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[MetaOapg.additional_properties, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["visibleFilters"], typing_extensions.Literal["widget"], str, ]): + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + visibleFilters: typing.Union[MetaOapg.properties.visibleFilters, list, tuple, schemas.Unset] = schemas.unset, + widget: typing.Union[MetaOapg.properties.widget, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + ) -> 'AutomationMetadata': + return super().__new__( + cls, + *_args, + visibleFilters=visibleFilters, + widget=widget, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.visible_filter import VisibleFilter diff --git a/gooddata-api-client/gooddata_api_client/model/automation_notification.py b/gooddata-api-client/gooddata_api_client/model/automation_notification.py index 461a3f29a..5abe385de 100644 --- a/gooddata-api-client/gooddata_api_client/model/automation_notification.py +++ b/gooddata-api-client/gooddata_api_client/model/automation_notification.py @@ -31,15 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.automation_notification import AutomationNotification from gooddata_api_client.model.automation_notification_all_of import AutomationNotificationAllOf from gooddata_api_client.model.notification_content import NotificationContent - from gooddata_api_client.model.test_notification import TestNotification from gooddata_api_client.model.webhook_message import WebhookMessage - globals()['AutomationNotification'] = AutomationNotification globals()['AutomationNotificationAllOf'] = AutomationNotificationAllOf globals()['NotificationContent'] = NotificationContent - globals()['TestNotification'] = TestNotification globals()['WebhookMessage'] = WebhookMessage @@ -102,10 +98,7 @@ def openapi_types(): @cached_property def discriminator(): - lazy_import() val = { - 'AUTOMATION': AutomationNotification, - 'TEST': TestNotification, } if not val: return None diff --git a/gooddata-api-client/gooddata_api_client/model/automation_notification.pyi b/gooddata-api-client/gooddata_api_client/model/automation_notification.pyi new file mode 100644 index 000000000..36234ac3f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/automation_notification.pyi @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AutomationNotification( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "content", + } + + @staticmethod + def discriminator(): + return { + 'type': { + 'AUTOMATION': AutomationNotification, + 'TEST': TestNotification, + } + } + + + class all_of_1( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def content() -> typing.Type['WebhookMessage']: + return WebhookMessage + __annotations__ = { + "content": content, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> 'WebhookMessage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["content", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union['WebhookMessage', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["content", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + content: typing.Union['WebhookMessage', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + content=content, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + NotificationContent, + cls.all_of_1, + ] + + + content: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AutomationNotification': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.automation_notification import AutomationNotification +from gooddata_api_client.model.notification_content import NotificationContent +from gooddata_api_client.model.test_notification import TestNotification +from gooddata_api_client.model.webhook_message import WebhookMessage diff --git a/gooddata-api-client/gooddata_api_client/model/automation_raw_export.pyi b/gooddata-api-client/gooddata_api_client/model/automation_raw_export.pyi new file mode 100644 index 000000000..8ca82735b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/automation_raw_export.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AutomationRawExport( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['RawExportAutomationRequest']: + return RawExportAutomationRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'RawExportAutomationRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'RawExportAutomationRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'RawExportAutomationRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'RawExportAutomationRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AutomationRawExport': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.raw_export_automation_request import RawExportAutomationRequest diff --git a/gooddata-api-client/gooddata_api_client/model/automation_schedule.pyi b/gooddata-api-client/gooddata_api_client/model/automation_schedule.pyi new file mode 100644 index 000000000..923a2d02e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/automation_schedule.pyi @@ -0,0 +1,126 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AutomationSchedule( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "cron", + "timezone", + } + + class properties: + + + class cron( + schemas.StrSchema + ): + pass + + + class timezone( + schemas.StrSchema + ): + pass + cronDescription = schemas.StrSchema + firstRun = schemas.DateTimeSchema + __annotations__ = { + "cron": cron, + "timezone": timezone, + "cronDescription": cronDescription, + "firstRun": firstRun, + } + + cron: MetaOapg.properties.cron + timezone: MetaOapg.properties.timezone + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["cron"]) -> MetaOapg.properties.cron: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["timezone"]) -> MetaOapg.properties.timezone: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["cronDescription"]) -> MetaOapg.properties.cronDescription: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["firstRun"]) -> MetaOapg.properties.firstRun: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["cron", "timezone", "cronDescription", "firstRun", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["cron"]) -> MetaOapg.properties.cron: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["timezone"]) -> MetaOapg.properties.timezone: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["cronDescription"]) -> typing.Union[MetaOapg.properties.cronDescription, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["firstRun"]) -> typing.Union[MetaOapg.properties.firstRun, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["cron", "timezone", "cronDescription", "firstRun", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + cron: typing.Union[MetaOapg.properties.cron, str, ], + timezone: typing.Union[MetaOapg.properties.timezone, str, ], + cronDescription: typing.Union[MetaOapg.properties.cronDescription, str, schemas.Unset] = schemas.unset, + firstRun: typing.Union[MetaOapg.properties.firstRun, str, datetime, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AutomationSchedule': + return super().__new__( + cls, + *_args, + cron=cron, + timezone=timezone, + cronDescription=cronDescription, + firstRun=firstRun, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/automation_slides_export.pyi b/gooddata-api-client/gooddata_api_client/model/automation_slides_export.pyi new file mode 100644 index 000000000..7c404105c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/automation_slides_export.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AutomationSlidesExport( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['SlidesExportRequest']: + return SlidesExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'SlidesExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'SlidesExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'SlidesExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'SlidesExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AutomationSlidesExport': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.slides_export_request import SlidesExportRequest diff --git a/gooddata-api-client/gooddata_api_client/model/automation_tabular_export.pyi b/gooddata-api-client/gooddata_api_client/model/automation_tabular_export.pyi new file mode 100644 index 000000000..7def7a4d7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/automation_tabular_export.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AutomationTabularExport( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['TabularExportRequest']: + return TabularExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'TabularExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'TabularExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'TabularExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'TabularExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AutomationTabularExport': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.tabular_export_request import TabularExportRequest diff --git a/gooddata-api-client/gooddata_api_client/model/automation_visual_export.pyi b/gooddata-api-client/gooddata_api_client/model/automation_visual_export.pyi new file mode 100644 index 000000000..0fe61afe5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/automation_visual_export.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AutomationVisualExport( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['VisualExportRequest']: + return VisualExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'VisualExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'VisualExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'VisualExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'VisualExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AutomationVisualExport': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.visual_export_request import VisualExportRequest diff --git a/gooddata-api-client/gooddata_api_client/model/aws_bedrock_access_key_auth.py b/gooddata-api-client/gooddata_api_client/model/aws_bedrock_access_key_auth.py new file mode 100644 index 000000000..3277635c8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aws_bedrock_access_key_auth.py @@ -0,0 +1,346 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.aws_bedrock_access_key_auth_all_of import AwsBedrockAccessKeyAuthAllOf + globals()['AwsBedrockAccessKeyAuthAllOf'] = AwsBedrockAccessKeyAuthAllOf + + +class AwsBedrockAccessKeyAuth(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',): { + 'ACCESS_KEY': "ACCESS_KEY", + }, + } + + validations = { + ('access_key_id',): { + 'max_length': 255, + }, + ('secret_access_key',): { + 'max_length': 10000, + }, + ('session_token',): { + 'max_length': 10000, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'type': (str,), # noqa: E501 + 'access_key_id': (str, none_type,), # noqa: E501 + 'secret_access_key': (str, none_type,), # noqa: E501 + 'session_token': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'access_key_id': 'accessKeyId', # noqa: E501 + 'secret_access_key': 'secretAccessKey', # noqa: E501 + 'session_token': 'sessionToken', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AwsBedrockAccessKeyAuth - a model defined in OpenAPI + + Keyword Args: + type (str): Authentication type.. defaults to "ACCESS_KEY", must be one of ["ACCESS_KEY", ] # 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,) + access_key_id (str, none_type): AWS Access Key ID.. [optional] # noqa: E501 + secret_access_key (str, none_type): AWS Secret Access Key.. [optional] # noqa: E501 + session_token (str, none_type): AWS Session Token (for temporary credentials).. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "ACCESS_KEY") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_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 + """AwsBedrockAccessKeyAuth - a model defined in OpenAPI + + Keyword Args: + type (str): Authentication type.. defaults to "ACCESS_KEY", must be one of ["ACCESS_KEY", ] # 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,) + access_key_id (str, none_type): AWS Access Key ID.. [optional] # noqa: E501 + secret_access_key (str, none_type): AWS Secret Access Key.. [optional] # noqa: E501 + session_token (str, none_type): AWS Session Token (for temporary credentials).. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "ACCESS_KEY") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_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': [ + AwsBedrockAccessKeyAuthAllOf, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/aws_bedrock_access_key_auth.pyi b/gooddata-api-client/gooddata_api_client/model/aws_bedrock_access_key_auth.pyi new file mode 100644 index 000000000..154f37883 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aws_bedrock_access_key_auth.pyi @@ -0,0 +1,226 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AwsBedrockAccessKeyAuth( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "type", + } + + + class all_of_0( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class accessKeyId( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'accessKeyId': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class secretAccessKey( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'secretAccessKey': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class sessionToken( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'sessionToken': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ACCESS_KEY(cls): + return cls("ACCESS_KEY") + __annotations__ = { + "accessKeyId": accessKeyId, + "secretAccessKey": secretAccessKey, + "sessionToken": sessionToken, + "type": type, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["accessKeyId"]) -> MetaOapg.properties.accessKeyId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["secretAccessKey"]) -> MetaOapg.properties.secretAccessKey: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sessionToken"]) -> MetaOapg.properties.sessionToken: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["accessKeyId", "secretAccessKey", "sessionToken", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["accessKeyId"]) -> typing.Union[MetaOapg.properties.accessKeyId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["secretAccessKey"]) -> typing.Union[MetaOapg.properties.secretAccessKey, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sessionToken"]) -> typing.Union[MetaOapg.properties.sessionToken, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> typing.Union[MetaOapg.properties.type, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["accessKeyId", "secretAccessKey", "sessionToken", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + accessKeyId: typing.Union[MetaOapg.properties.accessKeyId, None, str, schemas.Unset] = schemas.unset, + secretAccessKey: typing.Union[MetaOapg.properties.secretAccessKey, None, str, schemas.Unset] = schemas.unset, + sessionToken: typing.Union[MetaOapg.properties.sessionToken, None, str, schemas.Unset] = schemas.unset, + type: typing.Union[MetaOapg.properties.type, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + accessKeyId=accessKeyId, + secretAccessKey=secretAccessKey, + sessionToken=sessionToken, + type=type, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + ] + + + type: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AwsBedrockAccessKeyAuth': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/aws_bedrock_access_key_auth_all_of.py b/gooddata-api-client/gooddata_api_client/model/aws_bedrock_access_key_auth_all_of.py new file mode 100644 index 000000000..606ab6020 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aws_bedrock_access_key_auth_all_of.py @@ -0,0 +1,288 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class AwsBedrockAccessKeyAuthAllOf(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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',): { + 'ACCESS_KEY': "ACCESS_KEY", + }, + } + + validations = { + ('access_key_id',): { + 'max_length': 255, + }, + ('secret_access_key',): { + 'max_length': 10000, + }, + ('session_token',): { + '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 { + 'access_key_id': (str, none_type,), # noqa: E501 + 'secret_access_key': (str, none_type,), # noqa: E501 + 'session_token': (str, none_type,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'access_key_id': 'accessKeyId', # noqa: E501 + 'secret_access_key': 'secretAccessKey', # noqa: E501 + 'session_token': 'sessionToken', # 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 + """AwsBedrockAccessKeyAuthAllOf - 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,) + access_key_id (str, none_type): AWS Access Key ID.. [optional] # noqa: E501 + secret_access_key (str, none_type): AWS Secret Access Key.. [optional] # noqa: E501 + session_token (str, none_type): AWS Session Token (for temporary credentials).. [optional] # noqa: E501 + type (str): Authentication type.. [optional] if omitted the server will use the default value of "ACCESS_KEY" # 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 + """AwsBedrockAccessKeyAuthAllOf - 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,) + access_key_id (str, none_type): AWS Access Key ID.. [optional] # noqa: E501 + secret_access_key (str, none_type): AWS Secret Access Key.. [optional] # noqa: E501 + session_token (str, none_type): AWS Session Token (for temporary credentials).. [optional] # noqa: E501 + type (str): Authentication type.. [optional] if omitted the server will use the default value of "ACCESS_KEY" # 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/aws_bedrock_provider_config.py b/gooddata-api-client/gooddata_api_client/model/aws_bedrock_provider_config.py new file mode 100644 index 000000000..d005dc3c0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aws_bedrock_provider_config.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.bedrock_provider_auth import BedrockProviderAuth + globals()['BedrockProviderAuth'] = BedrockProviderAuth + + +class AwsBedrockProviderConfig(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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',): { + 'AWS_BEDROCK': "AWS_BEDROCK", + }, + } + + validations = { + ('region',): { + '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 { + 'auth': (BedrockProviderAuth,), # noqa: E501 + 'region': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'auth': 'auth', # noqa: E501 + 'region': 'region', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, auth, region, *args, **kwargs): # noqa: E501 + """AwsBedrockProviderConfig - a model defined in OpenAPI + + Args: + auth (BedrockProviderAuth): + region (str): AWS region for Bedrock. + + Keyword Args: + type (str): Provider type.. defaults to "AWS_BEDROCK", must be one of ["AWS_BEDROCK", ] # 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', "AWS_BEDROCK") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.auth = auth + self.region = region + 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, auth, region, *args, **kwargs): # noqa: E501 + """AwsBedrockProviderConfig - a model defined in OpenAPI + + Args: + auth (BedrockProviderAuth): + region (str): AWS region for Bedrock. + + Keyword Args: + type (str): Provider type.. defaults to "AWS_BEDROCK", must be one of ["AWS_BEDROCK", ] # 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', "AWS_BEDROCK") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.auth = auth + self.region = region + 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/aws_bedrock_provider_config.pyi b/gooddata-api-client/gooddata_api_client/model/aws_bedrock_provider_config.pyi new file mode 100644 index 000000000..a5198f85c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/aws_bedrock_provider_config.pyi @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AwsBedrockProviderConfig( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Configuration for AWS Bedrock provider. + """ + + + class MetaOapg: + required = { + "auth", + "region", + "type", + } + + class properties: + + @staticmethod + def auth() -> typing.Type['BedrockProviderAuth']: + return BedrockProviderAuth + + + class region( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def AWS_BEDROCK(cls): + return cls("AWS_BEDROCK") + __annotations__ = { + "auth": auth, + "region": region, + "type": type, + } + + auth: 'BedrockProviderAuth' + region: MetaOapg.properties.region + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["auth"]) -> 'BedrockProviderAuth': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["region"]) -> MetaOapg.properties.region: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["auth", "region", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["auth"]) -> 'BedrockProviderAuth': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["region"]) -> MetaOapg.properties.region: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["auth", "region", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + auth: 'BedrockProviderAuth', + region: typing.Union[MetaOapg.properties.region, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AwsBedrockProviderConfig': + return super().__new__( + cls, + *_args, + auth=auth, + region=region, + type=type, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.bedrock_provider_auth import BedrockProviderAuth diff --git a/gooddata-api-client/gooddata_api_client/model/azure_foundry_api_key_auth.py b/gooddata-api-client/gooddata_api_client/model/azure_foundry_api_key_auth.py new file mode 100644 index 000000000..ae15cd641 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/azure_foundry_api_key_auth.py @@ -0,0 +1,332 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.azure_foundry_api_key_auth_all_of import AzureFoundryApiKeyAuthAllOf + globals()['AzureFoundryApiKeyAuthAllOf'] = AzureFoundryApiKeyAuthAllOf + + +class AzureFoundryApiKeyAuth(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',): { + 'API_KEY': "API_KEY", + }, + } + + validations = { + ('api_key',): { + '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 { + 'type': (str,), # noqa: E501 + 'api_key': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'api_key': 'apiKey', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AzureFoundryApiKeyAuth - a model defined in OpenAPI + + Keyword Args: + type (str): Authentication type.. defaults to "API_KEY", must be one of ["API_KEY", ] # 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,) + api_key (str, none_type): Azure API key.. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "API_KEY") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_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 + """AzureFoundryApiKeyAuth - a model defined in OpenAPI + + Keyword Args: + type (str): Authentication type.. defaults to "API_KEY", must be one of ["API_KEY", ] # 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,) + api_key (str, none_type): Azure API key.. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "API_KEY") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_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': [ + AzureFoundryApiKeyAuthAllOf, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/azure_foundry_api_key_auth.pyi b/gooddata-api-client/gooddata_api_client/model/azure_foundry_api_key_auth.pyi new file mode 100644 index 000000000..5346e81c3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/azure_foundry_api_key_auth.pyi @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AzureFoundryApiKeyAuth( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "type", + } + + + class all_of_0( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class apiKey( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'apiKey': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def API_KEY(cls): + return cls("API_KEY") + __annotations__ = { + "apiKey": apiKey, + "type": type, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["apiKey"]) -> MetaOapg.properties.apiKey: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["apiKey", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["apiKey"]) -> typing.Union[MetaOapg.properties.apiKey, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> typing.Union[MetaOapg.properties.type, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["apiKey", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + apiKey: typing.Union[MetaOapg.properties.apiKey, None, str, schemas.Unset] = schemas.unset, + type: typing.Union[MetaOapg.properties.type, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + apiKey=apiKey, + type=type, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + ] + + + type: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AzureFoundryApiKeyAuth': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/azure_foundry_api_key_auth_all_of.py b/gooddata-api-client/gooddata_api_client/model/azure_foundry_api_key_auth_all_of.py new file mode 100644 index 000000000..600ea1c53 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/azure_foundry_api_key_auth_all_of.py @@ -0,0 +1,274 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class AzureFoundryApiKeyAuthAllOf(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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',): { + 'API_KEY': "API_KEY", + }, + } + + validations = { + ('api_key',): { + '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 { + 'api_key': (str, none_type,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'api_key': 'apiKey', # 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 + """AzureFoundryApiKeyAuthAllOf - 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,) + api_key (str, none_type): Azure API key.. [optional] # noqa: E501 + type (str): Authentication type.. [optional] if omitted the server will use the default value of "API_KEY" # 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 + """AzureFoundryApiKeyAuthAllOf - 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,) + api_key (str, none_type): Azure API key.. [optional] # noqa: E501 + type (str): Authentication type.. [optional] if omitted the server will use the default value of "API_KEY" # 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/azure_foundry_provider_auth.py b/gooddata-api-client/gooddata_api_client/model/azure_foundry_provider_auth.py new file mode 100644 index 000000000..bfdebba63 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/azure_foundry_provider_auth.py @@ -0,0 +1,330 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.azure_foundry_api_key_auth import AzureFoundryApiKeyAuth + globals()['AzureFoundryApiKeyAuth'] = AzureFoundryApiKeyAuth + + +class AzureFoundryProviderAuth(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',): { + 'API_KEY': "API_KEY", + }, + } + + validations = { + ('api_key',): { + '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 { + 'api_key': (str, none_type,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'api_key': 'apiKey', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AzureFoundryProviderAuth - 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,) + api_key (str, none_type): Azure API key.. [optional] # noqa: E501 + type (str): Authentication type.. [optional] if omitted the server will use the default value of "API_KEY" # 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 + """AzureFoundryProviderAuth - 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,) + api_key (str, none_type): Azure API key.. [optional] # noqa: E501 + type (str): Authentication type.. [optional] if omitted the server will use the default value of "API_KEY" # 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': [ + AzureFoundryApiKeyAuth, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/azure_foundry_provider_auth.pyi b/gooddata-api-client/gooddata_api_client/model/azure_foundry_provider_auth.pyi new file mode 100644 index 000000000..dcb3ace6b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/azure_foundry_provider_auth.pyi @@ -0,0 +1,70 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AzureFoundryProviderAuth( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Authentication configuration. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AzureFoundryApiKeyAuth, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AzureFoundryProviderAuth': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.azure_foundry_api_key_auth import AzureFoundryApiKeyAuth diff --git a/gooddata-api-client/gooddata_api_client/model/azure_foundry_provider_config.py b/gooddata-api-client/gooddata_api_client/model/azure_foundry_provider_config.py new file mode 100644 index 000000000..aef53e2ec --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/azure_foundry_provider_config.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.azure_foundry_provider_auth import AzureFoundryProviderAuth + globals()['AzureFoundryProviderAuth'] = AzureFoundryProviderAuth + + +class AzureFoundryProviderConfig(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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',): { + 'AZURE_FOUNDRY': "AZURE_FOUNDRY", + }, + } + + validations = { + ('endpoint',): { + '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 { + 'auth': (AzureFoundryProviderAuth,), # noqa: E501 + 'endpoint': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'auth': 'auth', # noqa: E501 + 'endpoint': 'endpoint', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, auth, endpoint, *args, **kwargs): # noqa: E501 + """AzureFoundryProviderConfig - a model defined in OpenAPI + + Args: + auth (AzureFoundryProviderAuth): + endpoint (str): Azure AI inference endpoint URL. + + Keyword Args: + type (str): Provider type.. defaults to "AZURE_FOUNDRY", must be one of ["AZURE_FOUNDRY", ] # 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', "AZURE_FOUNDRY") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.auth = auth + self.endpoint = endpoint + 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, auth, endpoint, *args, **kwargs): # noqa: E501 + """AzureFoundryProviderConfig - a model defined in OpenAPI + + Args: + auth (AzureFoundryProviderAuth): + endpoint (str): Azure AI inference endpoint URL. + + Keyword Args: + type (str): Provider type.. defaults to "AZURE_FOUNDRY", must be one of ["AZURE_FOUNDRY", ] # 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', "AZURE_FOUNDRY") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.auth = auth + self.endpoint = endpoint + 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/azure_foundry_provider_config.pyi b/gooddata-api-client/gooddata_api_client/model/azure_foundry_provider_config.pyi new file mode 100644 index 000000000..ec915b36e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/azure_foundry_provider_config.pyi @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class AzureFoundryProviderConfig( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Configuration for Azure Foundry provider. + """ + + + class MetaOapg: + required = { + "endpoint", + "auth", + "type", + } + + class properties: + + @staticmethod + def auth() -> typing.Type['AzureFoundryProviderAuth']: + return AzureFoundryProviderAuth + + + class endpoint( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def AZURE_FOUNDRY(cls): + return cls("AZURE_FOUNDRY") + __annotations__ = { + "auth": auth, + "endpoint": endpoint, + "type": type, + } + + endpoint: MetaOapg.properties.endpoint + auth: 'AzureFoundryProviderAuth' + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["auth"]) -> 'AzureFoundryProviderAuth': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["endpoint"]) -> MetaOapg.properties.endpoint: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["auth", "endpoint", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["auth"]) -> 'AzureFoundryProviderAuth': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["endpoint"]) -> MetaOapg.properties.endpoint: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["auth", "endpoint", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + endpoint: typing.Union[MetaOapg.properties.endpoint, str, ], + auth: 'AzureFoundryProviderAuth', + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'AzureFoundryProviderConfig': + return super().__new__( + cls, + *_args, + endpoint=endpoint, + auth=auth, + type=type, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.azure_foundry_provider_auth import AzureFoundryProviderAuth diff --git a/gooddata-api-client/gooddata_api_client/model/bedrock_provider_auth.py b/gooddata-api-client/gooddata_api_client/model/bedrock_provider_auth.py new file mode 100644 index 000000000..a6fd2dda8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/bedrock_provider_auth.py @@ -0,0 +1,344 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.aws_bedrock_access_key_auth import AwsBedrockAccessKeyAuth + globals()['AwsBedrockAccessKeyAuth'] = AwsBedrockAccessKeyAuth + + +class BedrockProviderAuth(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',): { + 'ACCESS_KEY': "ACCESS_KEY", + }, + } + + validations = { + ('access_key_id',): { + 'max_length': 255, + }, + ('secret_access_key',): { + 'max_length': 10000, + }, + ('session_token',): { + 'max_length': 10000, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'access_key_id': (str, none_type,), # noqa: E501 + 'secret_access_key': (str, none_type,), # noqa: E501 + 'session_token': (str, none_type,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'access_key_id': 'accessKeyId', # noqa: E501 + 'secret_access_key': 'secretAccessKey', # noqa: E501 + 'session_token': 'sessionToken', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """BedrockProviderAuth - 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,) + access_key_id (str, none_type): AWS Access Key ID.. [optional] # noqa: E501 + secret_access_key (str, none_type): AWS Secret Access Key.. [optional] # noqa: E501 + session_token (str, none_type): AWS Session Token (for temporary credentials).. [optional] # noqa: E501 + type (str): Authentication type.. [optional] if omitted the server will use the default value of "ACCESS_KEY" # 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 + """BedrockProviderAuth - 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,) + access_key_id (str, none_type): AWS Access Key ID.. [optional] # noqa: E501 + secret_access_key (str, none_type): AWS Secret Access Key.. [optional] # noqa: E501 + session_token (str, none_type): AWS Session Token (for temporary credentials).. [optional] # noqa: E501 + type (str): Authentication type.. [optional] if omitted the server will use the default value of "ACCESS_KEY" # 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': [ + AwsBedrockAccessKeyAuth, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/bedrock_provider_auth.pyi b/gooddata-api-client/gooddata_api_client/model/bedrock_provider_auth.pyi new file mode 100644 index 000000000..cb8a6dbd9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/bedrock_provider_auth.pyi @@ -0,0 +1,70 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class BedrockProviderAuth( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Authentication configuration. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AwsBedrockAccessKeyAuth, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'BedrockProviderAuth': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aws_bedrock_access_key_auth import AwsBedrockAccessKeyAuth diff --git a/gooddata-api-client/gooddata_api_client/model/bounded_filter.pyi b/gooddata-api-client/gooddata_api_client/model/bounded_filter.pyi new file mode 100644 index 000000000..a80aadf71 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/bounded_filter.pyi @@ -0,0 +1,233 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class BoundedFilter( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range. + """ + + + class MetaOapg: + required = { + "granularity", + } + + class properties: + + + class granularity( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MINUTE(cls): + return cls("MINUTE") + + @schemas.classproperty + def HOUR(cls): + return cls("HOUR") + + @schemas.classproperty + def DAY(cls): + return cls("DAY") + + @schemas.classproperty + def WEEK(cls): + return cls("WEEK") + + @schemas.classproperty + def MONTH(cls): + return cls("MONTH") + + @schemas.classproperty + def QUARTER(cls): + return cls("QUARTER") + + @schemas.classproperty + def YEAR(cls): + return cls("YEAR") + + @schemas.classproperty + def MINUTE_OF_HOUR(cls): + return cls("MINUTE_OF_HOUR") + + @schemas.classproperty + def HOUR_OF_DAY(cls): + return cls("HOUR_OF_DAY") + + @schemas.classproperty + def DAY_OF_WEEK(cls): + return cls("DAY_OF_WEEK") + + @schemas.classproperty + def DAY_OF_MONTH(cls): + return cls("DAY_OF_MONTH") + + @schemas.classproperty + def DAY_OF_QUARTER(cls): + return cls("DAY_OF_QUARTER") + + @schemas.classproperty + def DAY_OF_YEAR(cls): + return cls("DAY_OF_YEAR") + + @schemas.classproperty + def WEEK_OF_YEAR(cls): + return cls("WEEK_OF_YEAR") + + @schemas.classproperty + def MONTH_OF_YEAR(cls): + return cls("MONTH_OF_YEAR") + + @schemas.classproperty + def QUARTER_OF_YEAR(cls): + return cls("QUARTER_OF_YEAR") + + @schemas.classproperty + def FISCAL_MONTH(cls): + return cls("FISCAL_MONTH") + + @schemas.classproperty + def FISCAL_QUARTER(cls): + return cls("FISCAL_QUARTER") + + @schemas.classproperty + def FISCAL_YEAR(cls): + return cls("FISCAL_YEAR") + + + class _from( + schemas.Int32Base, + schemas.IntBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneDecimalMixin + ): + + + class MetaOapg: + format = 'int32' + + + def __new__( + cls, + *_args: typing.Union[None, decimal.Decimal, int, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> '_from': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class to( + schemas.Int32Base, + schemas.IntBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneDecimalMixin + ): + + + class MetaOapg: + format = 'int32' + + + def __new__( + cls, + *_args: typing.Union[None, decimal.Decimal, int, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'to': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + __annotations__ = { + "granularity": granularity, + "from": _from, + "to": to, + } + + granularity: MetaOapg.properties.granularity + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> MetaOapg.properties.to: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["granularity", "from", "to", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> typing.Union[MetaOapg.properties._from, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> typing.Union[MetaOapg.properties.to, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["granularity", "from", "to", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + granularity: typing.Union[MetaOapg.properties.granularity, str, ], + to: typing.Union[MetaOapg.properties.to, None, decimal.Decimal, int, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'BoundedFilter': + return super().__new__( + cls, + *_args, + granularity=granularity, + to=to, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/change_analysis_params.pyi b/gooddata-api-client/gooddata_api_client/model/change_analysis_params.pyi new file mode 100644 index 000000000..447fecf30 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/change_analysis_params.pyi @@ -0,0 +1,266 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ChangeAnalysisParams( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Change analysis specification. + """ + + + class MetaOapg: + required = { + "measureTitle", + "measure", + "referencePeriod", + "attributes", + "analyzedPeriod", + "filters", + "useSmartAttributeSelection", + "dateAttribute", + } + + class properties: + analyzedPeriod = schemas.StrSchema + + + class attributes( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AttributeItem']: + return AttributeItem + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AttributeItem'], typing.List['AttributeItem']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attributes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AttributeItem': + return super().__getitem__(i) + + @staticmethod + def dateAttribute() -> typing.Type['AttributeItem']: + return AttributeItem + + + class filters( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AbstractMeasureValueFilter, + FilterDefinitionForSimpleMeasure, + InlineFilterDefinition, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'filters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def measure() -> typing.Type['MeasureItem']: + return MeasureItem + measureTitle = schemas.StrSchema + referencePeriod = schemas.StrSchema + useSmartAttributeSelection = schemas.BoolSchema + __annotations__ = { + "analyzedPeriod": analyzedPeriod, + "attributes": attributes, + "dateAttribute": dateAttribute, + "filters": filters, + "measure": measure, + "measureTitle": measureTitle, + "referencePeriod": referencePeriod, + "useSmartAttributeSelection": useSmartAttributeSelection, + } + + measureTitle: MetaOapg.properties.measureTitle + measure: 'MeasureItem' + referencePeriod: MetaOapg.properties.referencePeriod + attributes: MetaOapg.properties.attributes + analyzedPeriod: MetaOapg.properties.analyzedPeriod + filters: MetaOapg.properties.filters + useSmartAttributeSelection: MetaOapg.properties.useSmartAttributeSelection + dateAttribute: 'AttributeItem' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyzedPeriod"]) -> MetaOapg.properties.analyzedPeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dateAttribute"]) -> 'AttributeItem': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["measure"]) -> 'MeasureItem': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["measureTitle"]) -> MetaOapg.properties.measureTitle: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["referencePeriod"]) -> MetaOapg.properties.referencePeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["useSmartAttributeSelection"]) -> MetaOapg.properties.useSmartAttributeSelection: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyzedPeriod", "attributes", "dateAttribute", "filters", "measure", "measureTitle", "referencePeriod", "useSmartAttributeSelection", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyzedPeriod"]) -> MetaOapg.properties.analyzedPeriod: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dateAttribute"]) -> 'AttributeItem': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["measure"]) -> 'MeasureItem': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["measureTitle"]) -> MetaOapg.properties.measureTitle: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["referencePeriod"]) -> MetaOapg.properties.referencePeriod: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["useSmartAttributeSelection"]) -> MetaOapg.properties.useSmartAttributeSelection: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyzedPeriod", "attributes", "dateAttribute", "filters", "measure", "measureTitle", "referencePeriod", "useSmartAttributeSelection", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + measureTitle: typing.Union[MetaOapg.properties.measureTitle, str, ], + measure: 'MeasureItem', + referencePeriod: typing.Union[MetaOapg.properties.referencePeriod, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, list, tuple, ], + analyzedPeriod: typing.Union[MetaOapg.properties.analyzedPeriod, str, ], + filters: typing.Union[MetaOapg.properties.filters, list, tuple, ], + useSmartAttributeSelection: typing.Union[MetaOapg.properties.useSmartAttributeSelection, bool, ], + dateAttribute: 'AttributeItem', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ChangeAnalysisParams': + return super().__new__( + cls, + *_args, + measureTitle=measureTitle, + measure=measure, + referencePeriod=referencePeriod, + attributes=attributes, + analyzedPeriod=analyzedPeriod, + filters=filters, + useSmartAttributeSelection=useSmartAttributeSelection, + dateAttribute=dateAttribute, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.abstract_measure_value_filter import AbstractMeasureValueFilter +from gooddata_api_client.model.attribute_item import AttributeItem +from gooddata_api_client.model.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure +from gooddata_api_client.model.inline_filter_definition import InlineFilterDefinition +from gooddata_api_client.model.measure_item import MeasureItem diff --git a/gooddata-api-client/gooddata_api_client/model/change_analysis_params_filters_inner.py b/gooddata-api-client/gooddata_api_client/model/change_analysis_params_filters_inner.py index ca0be4dab..d9da67d55 100644 --- a/gooddata-api-client/gooddata_api_client/model/change_analysis_params_filters_inner.py +++ b/gooddata-api-client/gooddata_api_client/model/change_analysis_params_filters_inner.py @@ -33,6 +33,7 @@ def lazy_import(): from gooddata_api_client.model.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter from gooddata_api_client.model.abstract_measure_value_filter import AbstractMeasureValueFilter + from gooddata_api_client.model.all_time_date_filter_all_time_date_filter import AllTimeDateFilterAllTimeDateFilter from gooddata_api_client.model.comparison_measure_value_filter_comparison_measure_value_filter import ComparisonMeasureValueFilterComparisonMeasureValueFilter from gooddata_api_client.model.compound_measure_value_filter_compound_measure_value_filter import CompoundMeasureValueFilterCompoundMeasureValueFilter from gooddata_api_client.model.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure @@ -46,6 +47,7 @@ def lazy_import(): from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter globals()['AbsoluteDateFilterAbsoluteDateFilter'] = AbsoluteDateFilterAbsoluteDateFilter globals()['AbstractMeasureValueFilter'] = AbstractMeasureValueFilter + globals()['AllTimeDateFilterAllTimeDateFilter'] = AllTimeDateFilterAllTimeDateFilter globals()['ComparisonMeasureValueFilterComparisonMeasureValueFilter'] = ComparisonMeasureValueFilterComparisonMeasureValueFilter globals()['CompoundMeasureValueFilterCompoundMeasureValueFilter'] = CompoundMeasureValueFilterCompoundMeasureValueFilter globals()['FilterDefinitionForSimpleMeasure'] = FilterDefinitionForSimpleMeasure @@ -118,6 +120,7 @@ def openapi_types(): 'ranking_filter': (RankingFilterRankingFilter,), # noqa: E501 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 + 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 'negative_attribute_filter': (NegativeAttributeFilterNegativeAttributeFilter,), # noqa: E501 'positive_attribute_filter': (PositiveAttributeFilterPositiveAttributeFilter,), # noqa: E501 'match_attribute_filter': (MatchAttributeFilterMatchAttributeFilter,), # noqa: E501 @@ -136,6 +139,7 @@ def discriminator(): 'ranking_filter': 'rankingFilter', # noqa: E501 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 'relative_date_filter': 'relativeDateFilter', # noqa: E501 + 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 'negative_attribute_filter': 'negativeAttributeFilter', # noqa: E501 'positive_attribute_filter': 'positiveAttributeFilter', # noqa: E501 'match_attribute_filter': 'matchAttributeFilter', # noqa: E501 @@ -187,6 +191,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 + all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 match_attribute_filter (MatchAttributeFilterMatchAttributeFilter): [optional] # noqa: E501 @@ -300,6 +305,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 + all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 match_attribute_filter (MatchAttributeFilterMatchAttributeFilter): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/change_analysis_request.pyi b/gooddata-api-client/gooddata_api_client/model/change_analysis_request.pyi new file mode 100644 index 000000000..3b45b57a5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/change_analysis_request.pyi @@ -0,0 +1,347 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ChangeAnalysisRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Request for change analysis computation + """ + + + class MetaOapg: + required = { + "measure", + "referencePeriod", + "analyzedPeriod", + "dateAttribute", + } + + class properties: + analyzedPeriod = schemas.StrSchema + + @staticmethod + def dateAttribute() -> typing.Type['AttributeItem']: + return AttributeItem + + @staticmethod + def measure() -> typing.Type['MeasureItem']: + return MeasureItem + referencePeriod = schemas.StrSchema + + + class attributes( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AttributeItem']: + return AttributeItem + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AttributeItem'], typing.List['AttributeItem']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attributes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AttributeItem': + return super().__getitem__(i) + + + class auxMeasures( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['MeasureItem']: + return MeasureItem + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['MeasureItem'], typing.List['MeasureItem']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'auxMeasures': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'MeasureItem': + return super().__getitem__(i) + + + class excludeTags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'excludeTags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class filters( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AbstractMeasureValueFilter, + FilterDefinitionForSimpleMeasure, + InlineFilterDefinition, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'filters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class includeTags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'includeTags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + useSmartAttributeSelection = schemas.BoolSchema + __annotations__ = { + "analyzedPeriod": analyzedPeriod, + "dateAttribute": dateAttribute, + "measure": measure, + "referencePeriod": referencePeriod, + "attributes": attributes, + "auxMeasures": auxMeasures, + "excludeTags": excludeTags, + "filters": filters, + "includeTags": includeTags, + "useSmartAttributeSelection": useSmartAttributeSelection, + } + + measure: 'MeasureItem' + referencePeriod: MetaOapg.properties.referencePeriod + analyzedPeriod: MetaOapg.properties.analyzedPeriod + dateAttribute: 'AttributeItem' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyzedPeriod"]) -> MetaOapg.properties.analyzedPeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dateAttribute"]) -> 'AttributeItem': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["measure"]) -> 'MeasureItem': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["referencePeriod"]) -> MetaOapg.properties.referencePeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["auxMeasures"]) -> MetaOapg.properties.auxMeasures: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["excludeTags"]) -> MetaOapg.properties.excludeTags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["includeTags"]) -> MetaOapg.properties.includeTags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["useSmartAttributeSelection"]) -> MetaOapg.properties.useSmartAttributeSelection: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyzedPeriod", "dateAttribute", "measure", "referencePeriod", "attributes", "auxMeasures", "excludeTags", "filters", "includeTags", "useSmartAttributeSelection", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyzedPeriod"]) -> MetaOapg.properties.analyzedPeriod: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dateAttribute"]) -> 'AttributeItem': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["measure"]) -> 'MeasureItem': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["referencePeriod"]) -> MetaOapg.properties.referencePeriod: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["auxMeasures"]) -> typing.Union[MetaOapg.properties.auxMeasures, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["excludeTags"]) -> typing.Union[MetaOapg.properties.excludeTags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filters"]) -> typing.Union[MetaOapg.properties.filters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["includeTags"]) -> typing.Union[MetaOapg.properties.includeTags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["useSmartAttributeSelection"]) -> typing.Union[MetaOapg.properties.useSmartAttributeSelection, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyzedPeriod", "dateAttribute", "measure", "referencePeriod", "attributes", "auxMeasures", "excludeTags", "filters", "includeTags", "useSmartAttributeSelection", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + measure: 'MeasureItem', + referencePeriod: typing.Union[MetaOapg.properties.referencePeriod, str, ], + analyzedPeriod: typing.Union[MetaOapg.properties.analyzedPeriod, str, ], + dateAttribute: 'AttributeItem', + attributes: typing.Union[MetaOapg.properties.attributes, list, tuple, schemas.Unset] = schemas.unset, + auxMeasures: typing.Union[MetaOapg.properties.auxMeasures, list, tuple, schemas.Unset] = schemas.unset, + excludeTags: typing.Union[MetaOapg.properties.excludeTags, list, tuple, schemas.Unset] = schemas.unset, + filters: typing.Union[MetaOapg.properties.filters, list, tuple, schemas.Unset] = schemas.unset, + includeTags: typing.Union[MetaOapg.properties.includeTags, list, tuple, schemas.Unset] = schemas.unset, + useSmartAttributeSelection: typing.Union[MetaOapg.properties.useSmartAttributeSelection, bool, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ChangeAnalysisRequest': + return super().__new__( + cls, + *_args, + measure=measure, + referencePeriod=referencePeriod, + analyzedPeriod=analyzedPeriod, + dateAttribute=dateAttribute, + attributes=attributes, + auxMeasures=auxMeasures, + excludeTags=excludeTags, + filters=filters, + includeTags=includeTags, + useSmartAttributeSelection=useSmartAttributeSelection, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.abstract_measure_value_filter import AbstractMeasureValueFilter +from gooddata_api_client.model.attribute_item import AttributeItem +from gooddata_api_client.model.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure +from gooddata_api_client.model.inline_filter_definition import InlineFilterDefinition +from gooddata_api_client.model.measure_item import MeasureItem diff --git a/gooddata-api-client/gooddata_api_client/model/change_analysis_response.pyi b/gooddata-api-client/gooddata_api_client/model/change_analysis_response.pyi new file mode 100644 index 000000000..e483e3773 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/change_analysis_response.pyi @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ChangeAnalysisResponse( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Response for change analysis computation + """ + + + class MetaOapg: + required = { + "links", + } + + class properties: + + @staticmethod + def links() -> typing.Type['ExecutionLinks']: + return ExecutionLinks + __annotations__ = { + "links": links, + } + + links: 'ExecutionLinks' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ExecutionLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> 'ExecutionLinks': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + links: 'ExecutionLinks', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ChangeAnalysisResponse': + return super().__new__( + cls, + *_args, + links=links, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.execution_links import ExecutionLinks diff --git a/gooddata-api-client/gooddata_api_client/model/change_analysis_result.pyi b/gooddata-api-client/gooddata_api_client/model/change_analysis_result.pyi new file mode 100644 index 000000000..4f009c135 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/change_analysis_result.pyi @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ChangeAnalysisResult( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Result of a change analysis execution. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['MetricValueChange']: + return MetricValueChange + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['MetricValueChange'], typing.List['MetricValueChange']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'MetricValueChange': + return super().__getitem__(i) + __annotations__ = { + "data": data, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ChangeAnalysisResult': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.metric_value_change import MetricValueChange diff --git a/gooddata-api-client/gooddata_api_client/model/chat_history_interaction.pyi b/gooddata-api-client/gooddata_api_client/model/chat_history_interaction.pyi new file mode 100644 index 000000000..152134545 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/chat_history_interaction.pyi @@ -0,0 +1,259 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ChatHistoryInteraction( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + List of chat history interactions. + """ + + + class MetaOapg: + required = { + "routing", + "question", + "chatHistoryInteractionId", + "interactionFinished", + } + + class properties: + chatHistoryInteractionId = schemas.StrSchema + interactionFinished = schemas.BoolSchema + + + class question( + schemas.StrSchema + ): + pass + + @staticmethod + def routing() -> typing.Type['RouteResult']: + return RouteResult + + @staticmethod + def changeAnalysisParams() -> typing.Type['ChangeAnalysisParams']: + return ChangeAnalysisParams + + @staticmethod + def createdVisualizations() -> typing.Type['CreatedVisualizations']: + return CreatedVisualizations + errorResponse = schemas.StrSchema + + @staticmethod + def foundObjects() -> typing.Type['FoundObjects']: + return FoundObjects + + @staticmethod + def reasoning() -> typing.Type['Reasoning']: + return Reasoning + + @staticmethod + def semanticSearch() -> typing.Type['SearchResult']: + return SearchResult + textResponse = schemas.StrSchema + threadIdSuffix = schemas.StrSchema + + + class userFeedback( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def POSITIVE(cls): + return cls("POSITIVE") + + @schemas.classproperty + def NEGATIVE(cls): + return cls("NEGATIVE") + + @schemas.classproperty + def NONE(cls): + return cls("NONE") + __annotations__ = { + "chatHistoryInteractionId": chatHistoryInteractionId, + "interactionFinished": interactionFinished, + "question": question, + "routing": routing, + "changeAnalysisParams": changeAnalysisParams, + "createdVisualizations": createdVisualizations, + "errorResponse": errorResponse, + "foundObjects": foundObjects, + "reasoning": reasoning, + "semanticSearch": semanticSearch, + "textResponse": textResponse, + "threadIdSuffix": threadIdSuffix, + "userFeedback": userFeedback, + } + + routing: 'RouteResult' + question: MetaOapg.properties.question + chatHistoryInteractionId: MetaOapg.properties.chatHistoryInteractionId + interactionFinished: MetaOapg.properties.interactionFinished + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["chatHistoryInteractionId"]) -> MetaOapg.properties.chatHistoryInteractionId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["interactionFinished"]) -> MetaOapg.properties.interactionFinished: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["question"]) -> MetaOapg.properties.question: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["routing"]) -> 'RouteResult': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["changeAnalysisParams"]) -> 'ChangeAnalysisParams': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdVisualizations"]) -> 'CreatedVisualizations': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["errorResponse"]) -> MetaOapg.properties.errorResponse: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["foundObjects"]) -> 'FoundObjects': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["reasoning"]) -> 'Reasoning': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["semanticSearch"]) -> 'SearchResult': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["textResponse"]) -> MetaOapg.properties.textResponse: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["threadIdSuffix"]) -> MetaOapg.properties.threadIdSuffix: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["userFeedback"]) -> MetaOapg.properties.userFeedback: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["chatHistoryInteractionId", "interactionFinished", "question", "routing", "changeAnalysisParams", "createdVisualizations", "errorResponse", "foundObjects", "reasoning", "semanticSearch", "textResponse", "threadIdSuffix", "userFeedback", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["chatHistoryInteractionId"]) -> MetaOapg.properties.chatHistoryInteractionId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["interactionFinished"]) -> MetaOapg.properties.interactionFinished: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["question"]) -> MetaOapg.properties.question: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["routing"]) -> 'RouteResult': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["changeAnalysisParams"]) -> typing.Union['ChangeAnalysisParams', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdVisualizations"]) -> typing.Union['CreatedVisualizations', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["errorResponse"]) -> typing.Union[MetaOapg.properties.errorResponse, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["foundObjects"]) -> typing.Union['FoundObjects', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["reasoning"]) -> typing.Union['Reasoning', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["semanticSearch"]) -> typing.Union['SearchResult', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["textResponse"]) -> typing.Union[MetaOapg.properties.textResponse, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["threadIdSuffix"]) -> typing.Union[MetaOapg.properties.threadIdSuffix, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["userFeedback"]) -> typing.Union[MetaOapg.properties.userFeedback, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["chatHistoryInteractionId", "interactionFinished", "question", "routing", "changeAnalysisParams", "createdVisualizations", "errorResponse", "foundObjects", "reasoning", "semanticSearch", "textResponse", "threadIdSuffix", "userFeedback", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + routing: 'RouteResult', + question: typing.Union[MetaOapg.properties.question, str, ], + chatHistoryInteractionId: typing.Union[MetaOapg.properties.chatHistoryInteractionId, str, ], + interactionFinished: typing.Union[MetaOapg.properties.interactionFinished, bool, ], + changeAnalysisParams: typing.Union['ChangeAnalysisParams', schemas.Unset] = schemas.unset, + createdVisualizations: typing.Union['CreatedVisualizations', schemas.Unset] = schemas.unset, + errorResponse: typing.Union[MetaOapg.properties.errorResponse, str, schemas.Unset] = schemas.unset, + foundObjects: typing.Union['FoundObjects', schemas.Unset] = schemas.unset, + reasoning: typing.Union['Reasoning', schemas.Unset] = schemas.unset, + semanticSearch: typing.Union['SearchResult', schemas.Unset] = schemas.unset, + textResponse: typing.Union[MetaOapg.properties.textResponse, str, schemas.Unset] = schemas.unset, + threadIdSuffix: typing.Union[MetaOapg.properties.threadIdSuffix, str, schemas.Unset] = schemas.unset, + userFeedback: typing.Union[MetaOapg.properties.userFeedback, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ChatHistoryInteraction': + return super().__new__( + cls, + *_args, + routing=routing, + question=question, + chatHistoryInteractionId=chatHistoryInteractionId, + interactionFinished=interactionFinished, + changeAnalysisParams=changeAnalysisParams, + createdVisualizations=createdVisualizations, + errorResponse=errorResponse, + foundObjects=foundObjects, + reasoning=reasoning, + semanticSearch=semanticSearch, + textResponse=textResponse, + threadIdSuffix=threadIdSuffix, + userFeedback=userFeedback, + _configuration=_configuration, + **kwargs, + ) + +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 diff --git a/gooddata-api-client/gooddata_api_client/model/chat_history_request.pyi b/gooddata-api-client/gooddata_api_client/model/chat_history_request.pyi new file mode 100644 index 000000000..b7b1da688 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/chat_history_request.pyi @@ -0,0 +1,194 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ChatHistoryRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + chatHistoryInteractionId = schemas.StrSchema + reset = schemas.BoolSchema + + + class responseState( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SUCCESSFUL(cls): + return cls("SUCCESSFUL") + + @schemas.classproperty + def UNEXPECTED_ERROR(cls): + return cls("UNEXPECTED_ERROR") + + @schemas.classproperty + def NOT_FOUND_ATTRIBUTES(cls): + return cls("NOT_FOUND_ATTRIBUTES") + + @schemas.classproperty + def TOO_MANY_DATA_POINTS(cls): + return cls("TOO_MANY_DATA_POINTS") + + @schemas.classproperty + def NO_DATA(cls): + return cls("NO_DATA") + + @schemas.classproperty + def NO_RESULTS(cls): + return cls("NO_RESULTS") + + @schemas.classproperty + def OUT_OF_TOPIC(cls): + return cls("OUT_OF_TOPIC") + + @staticmethod + def savedVisualization() -> typing.Type['SavedVisualization']: + return SavedVisualization + threadIdSuffix = schemas.StrSchema + + + class userFeedback( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def POSITIVE(cls): + return cls("POSITIVE") + + @schemas.classproperty + def NEGATIVE(cls): + return cls("NEGATIVE") + + @schemas.classproperty + def NONE(cls): + return cls("NONE") + userTextFeedback = schemas.StrSchema + __annotations__ = { + "chatHistoryInteractionId": chatHistoryInteractionId, + "reset": reset, + "responseState": responseState, + "savedVisualization": savedVisualization, + "threadIdSuffix": threadIdSuffix, + "userFeedback": userFeedback, + "userTextFeedback": userTextFeedback, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["chatHistoryInteractionId"]) -> MetaOapg.properties.chatHistoryInteractionId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["reset"]) -> MetaOapg.properties.reset: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["responseState"]) -> MetaOapg.properties.responseState: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["savedVisualization"]) -> 'SavedVisualization': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["threadIdSuffix"]) -> MetaOapg.properties.threadIdSuffix: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["userFeedback"]) -> MetaOapg.properties.userFeedback: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["userTextFeedback"]) -> MetaOapg.properties.userTextFeedback: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["chatHistoryInteractionId", "reset", "responseState", "savedVisualization", "threadIdSuffix", "userFeedback", "userTextFeedback", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["chatHistoryInteractionId"]) -> typing.Union[MetaOapg.properties.chatHistoryInteractionId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["reset"]) -> typing.Union[MetaOapg.properties.reset, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["responseState"]) -> typing.Union[MetaOapg.properties.responseState, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["savedVisualization"]) -> typing.Union['SavedVisualization', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["threadIdSuffix"]) -> typing.Union[MetaOapg.properties.threadIdSuffix, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["userFeedback"]) -> typing.Union[MetaOapg.properties.userFeedback, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["userTextFeedback"]) -> typing.Union[MetaOapg.properties.userTextFeedback, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["chatHistoryInteractionId", "reset", "responseState", "savedVisualization", "threadIdSuffix", "userFeedback", "userTextFeedback", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + chatHistoryInteractionId: typing.Union[MetaOapg.properties.chatHistoryInteractionId, str, schemas.Unset] = schemas.unset, + reset: typing.Union[MetaOapg.properties.reset, bool, schemas.Unset] = schemas.unset, + responseState: typing.Union[MetaOapg.properties.responseState, str, schemas.Unset] = schemas.unset, + savedVisualization: typing.Union['SavedVisualization', schemas.Unset] = schemas.unset, + threadIdSuffix: typing.Union[MetaOapg.properties.threadIdSuffix, str, schemas.Unset] = schemas.unset, + userFeedback: typing.Union[MetaOapg.properties.userFeedback, str, schemas.Unset] = schemas.unset, + userTextFeedback: typing.Union[MetaOapg.properties.userTextFeedback, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ChatHistoryRequest': + return super().__new__( + cls, + *_args, + chatHistoryInteractionId=chatHistoryInteractionId, + reset=reset, + responseState=responseState, + savedVisualization=savedVisualization, + threadIdSuffix=threadIdSuffix, + userFeedback=userFeedback, + userTextFeedback=userTextFeedback, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.saved_visualization import SavedVisualization diff --git a/gooddata-api-client/gooddata_api_client/model/chat_history_result.pyi b/gooddata-api-client/gooddata_api_client/model/chat_history_result.pyi new file mode 100644 index 000000000..eaa949c26 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/chat_history_result.pyi @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ChatHistoryResult( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "threadId", + "interactions", + } + + class properties: + + + class interactions( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ChatHistoryInteraction']: + return ChatHistoryInteraction + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['ChatHistoryInteraction'], typing.List['ChatHistoryInteraction']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'interactions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ChatHistoryInteraction': + return super().__getitem__(i) + threadId = schemas.StrSchema + __annotations__ = { + "interactions": interactions, + "threadId": threadId, + } + + threadId: MetaOapg.properties.threadId + interactions: MetaOapg.properties.interactions + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["interactions"]) -> MetaOapg.properties.interactions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["threadId"]) -> MetaOapg.properties.threadId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["interactions", "threadId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["interactions"]) -> MetaOapg.properties.interactions: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["threadId"]) -> MetaOapg.properties.threadId: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["interactions", "threadId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + threadId: typing.Union[MetaOapg.properties.threadId, str, ], + interactions: typing.Union[MetaOapg.properties.interactions, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ChatHistoryResult': + return super().__new__( + cls, + *_args, + threadId=threadId, + interactions=interactions, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.chat_history_interaction import ChatHistoryInteraction diff --git a/gooddata-api-client/gooddata_api_client/model/chat_request.pyi b/gooddata-api-client/gooddata_api_client/model/chat_request.pyi new file mode 100644 index 000000000..8303dc10c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/chat_request.pyi @@ -0,0 +1,289 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ChatRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "question", + } + + class properties: + + + class question( + schemas.StrSchema + ): + pass + + + class allowedRelationshipTypes( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AllowedRelationshipType']: + return AllowedRelationshipType + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AllowedRelationshipType'], typing.List['AllowedRelationshipType']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'allowedRelationshipTypes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AllowedRelationshipType': + return super().__getitem__(i) + includeHidden = schemas.BoolSchema + limitCreate = schemas.Int32Schema + limitCreateContext = schemas.Int32Schema + limitSearch = schemas.Int32Schema + + + class objectTypes( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ATTRIBUTE(cls): + return cls("attribute") + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def FACT(cls): + return cls("fact") + + @schemas.classproperty + def LABEL(cls): + return cls("label") + + @schemas.classproperty + def DATE(cls): + return cls("date") + + @schemas.classproperty + def DATASET(cls): + return cls("dataset") + + @schemas.classproperty + def VISUALIZATION(cls): + return cls("visualization") + + @schemas.classproperty + def DASHBOARD(cls): + return cls("dashboard") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'objectTypes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + relevantScoreThreshold = schemas.Float64Schema + searchScoreThreshold = schemas.Float64Schema + threadIdSuffix = schemas.StrSchema + titleToDescriptorRatio = schemas.Float64Schema + + @staticmethod + def userContext() -> typing.Type['UserContext']: + return UserContext + __annotations__ = { + "question": question, + "allowedRelationshipTypes": allowedRelationshipTypes, + "includeHidden": includeHidden, + "limitCreate": limitCreate, + "limitCreateContext": limitCreateContext, + "limitSearch": limitSearch, + "objectTypes": objectTypes, + "relevantScoreThreshold": relevantScoreThreshold, + "searchScoreThreshold": searchScoreThreshold, + "threadIdSuffix": threadIdSuffix, + "titleToDescriptorRatio": titleToDescriptorRatio, + "userContext": userContext, + } + + question: MetaOapg.properties.question + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["question"]) -> MetaOapg.properties.question: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["allowedRelationshipTypes"]) -> MetaOapg.properties.allowedRelationshipTypes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["includeHidden"]) -> MetaOapg.properties.includeHidden: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["limitCreate"]) -> MetaOapg.properties.limitCreate: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["limitCreateContext"]) -> MetaOapg.properties.limitCreateContext: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["limitSearch"]) -> MetaOapg.properties.limitSearch: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["objectTypes"]) -> MetaOapg.properties.objectTypes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relevantScoreThreshold"]) -> MetaOapg.properties.relevantScoreThreshold: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["searchScoreThreshold"]) -> MetaOapg.properties.searchScoreThreshold: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["threadIdSuffix"]) -> MetaOapg.properties.threadIdSuffix: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["titleToDescriptorRatio"]) -> MetaOapg.properties.titleToDescriptorRatio: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["userContext"]) -> 'UserContext': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["question", "allowedRelationshipTypes", "includeHidden", "limitCreate", "limitCreateContext", "limitSearch", "objectTypes", "relevantScoreThreshold", "searchScoreThreshold", "threadIdSuffix", "titleToDescriptorRatio", "userContext", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["question"]) -> MetaOapg.properties.question: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["allowedRelationshipTypes"]) -> typing.Union[MetaOapg.properties.allowedRelationshipTypes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["includeHidden"]) -> typing.Union[MetaOapg.properties.includeHidden, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["limitCreate"]) -> typing.Union[MetaOapg.properties.limitCreate, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["limitCreateContext"]) -> typing.Union[MetaOapg.properties.limitCreateContext, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["limitSearch"]) -> typing.Union[MetaOapg.properties.limitSearch, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["objectTypes"]) -> typing.Union[MetaOapg.properties.objectTypes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relevantScoreThreshold"]) -> typing.Union[MetaOapg.properties.relevantScoreThreshold, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["searchScoreThreshold"]) -> typing.Union[MetaOapg.properties.searchScoreThreshold, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["threadIdSuffix"]) -> typing.Union[MetaOapg.properties.threadIdSuffix, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["titleToDescriptorRatio"]) -> typing.Union[MetaOapg.properties.titleToDescriptorRatio, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["userContext"]) -> typing.Union['UserContext', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["question", "allowedRelationshipTypes", "includeHidden", "limitCreate", "limitCreateContext", "limitSearch", "objectTypes", "relevantScoreThreshold", "searchScoreThreshold", "threadIdSuffix", "titleToDescriptorRatio", "userContext", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + question: typing.Union[MetaOapg.properties.question, str, ], + allowedRelationshipTypes: typing.Union[MetaOapg.properties.allowedRelationshipTypes, list, tuple, schemas.Unset] = schemas.unset, + includeHidden: typing.Union[MetaOapg.properties.includeHidden, bool, schemas.Unset] = schemas.unset, + limitCreate: typing.Union[MetaOapg.properties.limitCreate, decimal.Decimal, int, schemas.Unset] = schemas.unset, + limitCreateContext: typing.Union[MetaOapg.properties.limitCreateContext, decimal.Decimal, int, schemas.Unset] = schemas.unset, + limitSearch: typing.Union[MetaOapg.properties.limitSearch, decimal.Decimal, int, schemas.Unset] = schemas.unset, + objectTypes: typing.Union[MetaOapg.properties.objectTypes, list, tuple, schemas.Unset] = schemas.unset, + relevantScoreThreshold: typing.Union[MetaOapg.properties.relevantScoreThreshold, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + searchScoreThreshold: typing.Union[MetaOapg.properties.searchScoreThreshold, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + threadIdSuffix: typing.Union[MetaOapg.properties.threadIdSuffix, str, schemas.Unset] = schemas.unset, + titleToDescriptorRatio: typing.Union[MetaOapg.properties.titleToDescriptorRatio, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + userContext: typing.Union['UserContext', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ChatRequest': + return super().__new__( + cls, + *_args, + question=question, + allowedRelationshipTypes=allowedRelationshipTypes, + includeHidden=includeHidden, + limitCreate=limitCreate, + limitCreateContext=limitCreateContext, + limitSearch=limitSearch, + objectTypes=objectTypes, + relevantScoreThreshold=relevantScoreThreshold, + searchScoreThreshold=searchScoreThreshold, + threadIdSuffix=threadIdSuffix, + titleToDescriptorRatio=titleToDescriptorRatio, + userContext=userContext, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.allowed_relationship_type import AllowedRelationshipType +from gooddata_api_client.model.user_context import UserContext diff --git a/gooddata-api-client/gooddata_api_client/model/chat_result.pyi b/gooddata-api-client/gooddata_api_client/model/chat_result.pyi new file mode 100644 index 000000000..56c2aad9b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/chat_result.pyi @@ -0,0 +1,194 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ChatResult( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + @staticmethod + def changeAnalysisParams() -> typing.Type['ChangeAnalysisParams']: + return ChangeAnalysisParams + chatHistoryInteractionId = schemas.StrSchema + + @staticmethod + def createdVisualizations() -> typing.Type['CreatedVisualizations']: + return CreatedVisualizations + errorResponse = schemas.StrSchema + + @staticmethod + def foundObjects() -> typing.Type['FoundObjects']: + return FoundObjects + + @staticmethod + def reasoning() -> typing.Type['Reasoning']: + return Reasoning + + @staticmethod + def routing() -> typing.Type['RouteResult']: + return RouteResult + + @staticmethod + def semanticSearch() -> typing.Type['SearchResult']: + return SearchResult + textResponse = schemas.StrSchema + threadIdSuffix = schemas.StrSchema + __annotations__ = { + "changeAnalysisParams": changeAnalysisParams, + "chatHistoryInteractionId": chatHistoryInteractionId, + "createdVisualizations": createdVisualizations, + "errorResponse": errorResponse, + "foundObjects": foundObjects, + "reasoning": reasoning, + "routing": routing, + "semanticSearch": semanticSearch, + "textResponse": textResponse, + "threadIdSuffix": threadIdSuffix, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["changeAnalysisParams"]) -> 'ChangeAnalysisParams': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["chatHistoryInteractionId"]) -> MetaOapg.properties.chatHistoryInteractionId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdVisualizations"]) -> 'CreatedVisualizations': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["errorResponse"]) -> MetaOapg.properties.errorResponse: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["foundObjects"]) -> 'FoundObjects': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["reasoning"]) -> 'Reasoning': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["routing"]) -> 'RouteResult': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["semanticSearch"]) -> 'SearchResult': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["textResponse"]) -> MetaOapg.properties.textResponse: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["threadIdSuffix"]) -> MetaOapg.properties.threadIdSuffix: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["changeAnalysisParams", "chatHistoryInteractionId", "createdVisualizations", "errorResponse", "foundObjects", "reasoning", "routing", "semanticSearch", "textResponse", "threadIdSuffix", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["changeAnalysisParams"]) -> typing.Union['ChangeAnalysisParams', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["chatHistoryInteractionId"]) -> typing.Union[MetaOapg.properties.chatHistoryInteractionId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdVisualizations"]) -> typing.Union['CreatedVisualizations', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["errorResponse"]) -> typing.Union[MetaOapg.properties.errorResponse, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["foundObjects"]) -> typing.Union['FoundObjects', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["reasoning"]) -> typing.Union['Reasoning', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["routing"]) -> typing.Union['RouteResult', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["semanticSearch"]) -> typing.Union['SearchResult', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["textResponse"]) -> typing.Union[MetaOapg.properties.textResponse, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["threadIdSuffix"]) -> typing.Union[MetaOapg.properties.threadIdSuffix, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["changeAnalysisParams", "chatHistoryInteractionId", "createdVisualizations", "errorResponse", "foundObjects", "reasoning", "routing", "semanticSearch", "textResponse", "threadIdSuffix", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + changeAnalysisParams: typing.Union['ChangeAnalysisParams', schemas.Unset] = schemas.unset, + chatHistoryInteractionId: typing.Union[MetaOapg.properties.chatHistoryInteractionId, str, schemas.Unset] = schemas.unset, + createdVisualizations: typing.Union['CreatedVisualizations', schemas.Unset] = schemas.unset, + errorResponse: typing.Union[MetaOapg.properties.errorResponse, str, schemas.Unset] = schemas.unset, + foundObjects: typing.Union['FoundObjects', schemas.Unset] = schemas.unset, + reasoning: typing.Union['Reasoning', schemas.Unset] = schemas.unset, + routing: typing.Union['RouteResult', schemas.Unset] = schemas.unset, + semanticSearch: typing.Union['SearchResult', schemas.Unset] = schemas.unset, + textResponse: typing.Union[MetaOapg.properties.textResponse, str, schemas.Unset] = schemas.unset, + threadIdSuffix: typing.Union[MetaOapg.properties.threadIdSuffix, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ChatResult': + return super().__new__( + cls, + *_args, + changeAnalysisParams=changeAnalysisParams, + chatHistoryInteractionId=chatHistoryInteractionId, + createdVisualizations=createdVisualizations, + errorResponse=errorResponse, + foundObjects=foundObjects, + reasoning=reasoning, + routing=routing, + semanticSearch=semanticSearch, + textResponse=textResponse, + threadIdSuffix=threadIdSuffix, + _configuration=_configuration, + **kwargs, + ) + +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 diff --git a/gooddata-api-client/gooddata_api_client/model/chat_usage_response.pyi b/gooddata-api-client/gooddata_api_client/model/chat_usage_response.pyi new file mode 100644 index 000000000..d266bd43b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/chat_usage_response.pyi @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ChatUsageResponse( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "interactionLimit", + "timeWindowHours", + "interactionCount", + } + + class properties: + interactionCount = schemas.Int32Schema + interactionLimit = schemas.Int32Schema + timeWindowHours = schemas.Int32Schema + __annotations__ = { + "interactionCount": interactionCount, + "interactionLimit": interactionLimit, + "timeWindowHours": timeWindowHours, + } + + interactionLimit: MetaOapg.properties.interactionLimit + timeWindowHours: MetaOapg.properties.timeWindowHours + interactionCount: MetaOapg.properties.interactionCount + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["interactionCount"]) -> MetaOapg.properties.interactionCount: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["interactionLimit"]) -> MetaOapg.properties.interactionLimit: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["timeWindowHours"]) -> MetaOapg.properties.timeWindowHours: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["interactionCount", "interactionLimit", "timeWindowHours", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["interactionCount"]) -> MetaOapg.properties.interactionCount: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["interactionLimit"]) -> MetaOapg.properties.interactionLimit: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["timeWindowHours"]) -> MetaOapg.properties.timeWindowHours: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["interactionCount", "interactionLimit", "timeWindowHours", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + interactionLimit: typing.Union[MetaOapg.properties.interactionLimit, decimal.Decimal, int, ], + timeWindowHours: typing.Union[MetaOapg.properties.timeWindowHours, decimal.Decimal, int, ], + interactionCount: typing.Union[MetaOapg.properties.interactionCount, decimal.Decimal, int, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ChatUsageResponse': + return super().__new__( + cls, + *_args, + interactionLimit=interactionLimit, + timeWindowHours=timeWindowHours, + interactionCount=interactionCount, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/clustering_config.py b/gooddata-api-client/gooddata_api_client/model/clustering_config.py new file mode 100644 index 000000000..f0777d585 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/clustering_config.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class 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_config.pyi b/gooddata-api-client/gooddata_api_client/model/clustering_config.pyi new file mode 100644 index 000000000..39c158c82 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/clustering_config.pyi @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ClusteringConfig( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Clustering configuration. + """ + + + class MetaOapg: + required = { + "numberOfClusters", + "threshold", + } + + class properties: + numberOfClusters = schemas.Int32Schema + threshold = schemas.Float32Schema + __annotations__ = { + "numberOfClusters": numberOfClusters, + "threshold": threshold, + } + + numberOfClusters: MetaOapg.properties.numberOfClusters + threshold: MetaOapg.properties.threshold + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["numberOfClusters"]) -> MetaOapg.properties.numberOfClusters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["threshold"]) -> MetaOapg.properties.threshold: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["numberOfClusters", "threshold", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["numberOfClusters"]) -> MetaOapg.properties.numberOfClusters: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["threshold"]) -> MetaOapg.properties.threshold: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["numberOfClusters", "threshold", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + numberOfClusters: typing.Union[MetaOapg.properties.numberOfClusters, decimal.Decimal, int, ], + threshold: typing.Union[MetaOapg.properties.threshold, decimal.Decimal, int, float, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ClusteringConfig': + return super().__new__( + cls, + *_args, + numberOfClusters=numberOfClusters, + threshold=threshold, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/clustering_request.pyi b/gooddata-api-client/gooddata_api_client/model/clustering_request.pyi new file mode 100644 index 000000000..627d9060e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/clustering_request.pyi @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ClusteringRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "numberOfClusters", + } + + class properties: + + + class numberOfClusters( + schemas.Int32Schema + ): + pass + + + class threshold( + schemas.Float64Schema + ): + pass + __annotations__ = { + "numberOfClusters": numberOfClusters, + "threshold": threshold, + } + + numberOfClusters: MetaOapg.properties.numberOfClusters + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["numberOfClusters"]) -> MetaOapg.properties.numberOfClusters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["threshold"]) -> MetaOapg.properties.threshold: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["numberOfClusters", "threshold", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["numberOfClusters"]) -> MetaOapg.properties.numberOfClusters: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["threshold"]) -> typing.Union[MetaOapg.properties.threshold, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["numberOfClusters", "threshold", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + numberOfClusters: typing.Union[MetaOapg.properties.numberOfClusters, decimal.Decimal, int, ], + threshold: typing.Union[MetaOapg.properties.threshold, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ClusteringRequest': + return super().__new__( + cls, + *_args, + numberOfClusters=numberOfClusters, + threshold=threshold, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/clustering_result.pyi b/gooddata-api-client/gooddata_api_client/model/clustering_result.pyi new file mode 100644 index 000000000..29bc8975b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/clustering_result.pyi @@ -0,0 +1,334 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ClusteringResult( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "xcoord", + "attribute", + "ycoord", + "clusters", + } + + class properties: + + + class attribute( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.DictSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attribute': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class clusters( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.Int32Base, + schemas.IntBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneDecimalMixin + ): + + + class MetaOapg: + format = 'int32' + + + def __new__( + cls, + *_args: typing.Union[None, decimal.Decimal, int, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, None, decimal.Decimal, int, ]], typing.List[typing.Union[MetaOapg.items, None, decimal.Decimal, int, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'clusters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class xcoord( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.NumberSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, decimal.Decimal, int, float, ]], typing.List[typing.Union[MetaOapg.items, decimal.Decimal, int, float, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'xcoord': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class ycoord( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.NumberSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, decimal.Decimal, int, float, ]], typing.List[typing.Union[MetaOapg.items, decimal.Decimal, int, float, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ycoord': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class xCoord( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.NumberBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneDecimalMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, decimal.Decimal, int, float, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, None, decimal.Decimal, int, float, ]], typing.List[typing.Union[MetaOapg.items, None, decimal.Decimal, int, float, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'xCoord': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class yCoord( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.NumberBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneDecimalMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, decimal.Decimal, int, float, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, None, decimal.Decimal, int, float, ]], typing.List[typing.Union[MetaOapg.items, None, decimal.Decimal, int, float, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'yCoord': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "attribute": attribute, + "clusters": clusters, + "xcoord": xcoord, + "ycoord": ycoord, + "xCoord": xCoord, + "yCoord": yCoord, + } + + xcoord: MetaOapg.properties.xcoord + attribute: MetaOapg.properties.attribute + ycoord: MetaOapg.properties.ycoord + clusters: MetaOapg.properties.clusters + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attribute"]) -> MetaOapg.properties.attribute: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["clusters"]) -> MetaOapg.properties.clusters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["xcoord"]) -> MetaOapg.properties.xcoord: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["ycoord"]) -> MetaOapg.properties.ycoord: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["xCoord"]) -> MetaOapg.properties.xCoord: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["yCoord"]) -> MetaOapg.properties.yCoord: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attribute", "clusters", "xcoord", "ycoord", "xCoord", "yCoord", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attribute"]) -> MetaOapg.properties.attribute: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["clusters"]) -> MetaOapg.properties.clusters: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["xcoord"]) -> MetaOapg.properties.xcoord: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["ycoord"]) -> MetaOapg.properties.ycoord: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["xCoord"]) -> typing.Union[MetaOapg.properties.xCoord, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["yCoord"]) -> typing.Union[MetaOapg.properties.yCoord, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attribute", "clusters", "xcoord", "ycoord", "xCoord", "yCoord", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + xcoord: typing.Union[MetaOapg.properties.xcoord, list, tuple, ], + attribute: typing.Union[MetaOapg.properties.attribute, list, tuple, ], + ycoord: typing.Union[MetaOapg.properties.ycoord, list, tuple, ], + clusters: typing.Union[MetaOapg.properties.clusters, list, tuple, ], + xCoord: typing.Union[MetaOapg.properties.xCoord, list, tuple, schemas.Unset] = schemas.unset, + yCoord: typing.Union[MetaOapg.properties.yCoord, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ClusteringResult': + return super().__new__( + cls, + *_args, + xcoord=xcoord, + attribute=attribute, + ycoord=ycoord, + clusters=clusters, + xCoord=xCoord, + yCoord=yCoord, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/column_location.pyi b/gooddata-api-client/gooddata_api_client/model/column_location.pyi new file mode 100644 index 000000000..00f979da7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/column_location.pyi @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 +ColumnLocation = schemas.DictSchema diff --git a/gooddata-api-client/gooddata_api_client/model/column_override.pyi b/gooddata-api-client/gooddata_api_client/model/column_override.pyi new file mode 100644 index 000000000..e7f5a7e59 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/column_override.pyi @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ColumnOverride( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Table column override. + """ + + + class MetaOapg: + required = { + "name", + } + + class properties: + name = schemas.StrSchema + labelTargetColumn = schemas.StrSchema + + + class labelType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def TEXT(cls): + return cls("TEXT") + + @schemas.classproperty + def HYPERLINK(cls): + return cls("HYPERLINK") + + @schemas.classproperty + def GEO(cls): + return cls("GEO") + + @schemas.classproperty + def GEO_LONGITUDE(cls): + return cls("GEO_LONGITUDE") + + @schemas.classproperty + def GEO_LATITUDE(cls): + return cls("GEO_LATITUDE") + + @schemas.classproperty + def GEO_AREA(cls): + return cls("GEO_AREA") + + @schemas.classproperty + def IMAGE(cls): + return cls("IMAGE") + + + class ldmTypeOverride( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def FACT(cls): + return cls("FACT") + + @schemas.classproperty + def LABEL(cls): + return cls("LABEL") + __annotations__ = { + "name": name, + "labelTargetColumn": labelTargetColumn, + "labelType": labelType, + "ldmTypeOverride": ldmTypeOverride, + } + + name: MetaOapg.properties.name + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["labelTargetColumn"]) -> MetaOapg.properties.labelTargetColumn: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["labelType"]) -> MetaOapg.properties.labelType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["ldmTypeOverride"]) -> MetaOapg.properties.ldmTypeOverride: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["name", "labelTargetColumn", "labelType", "ldmTypeOverride", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["labelTargetColumn"]) -> typing.Union[MetaOapg.properties.labelTargetColumn, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["labelType"]) -> typing.Union[MetaOapg.properties.labelType, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["ldmTypeOverride"]) -> typing.Union[MetaOapg.properties.ldmTypeOverride, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["name", "labelTargetColumn", "labelType", "ldmTypeOverride", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + name: typing.Union[MetaOapg.properties.name, str, ], + labelTargetColumn: typing.Union[MetaOapg.properties.labelTargetColumn, str, schemas.Unset] = schemas.unset, + labelType: typing.Union[MetaOapg.properties.labelType, str, schemas.Unset] = schemas.unset, + ldmTypeOverride: typing.Union[MetaOapg.properties.ldmTypeOverride, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ColumnOverride': + return super().__new__( + cls, + *_args, + name=name, + labelTargetColumn=labelTargetColumn, + labelType=labelType, + ldmTypeOverride=ldmTypeOverride, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/column_statistic.pyi b/gooddata-api-client/gooddata_api_client/model/column_statistic.pyi new file mode 100644 index 000000000..9b3bdbaae --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/column_statistic.pyi @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ColumnStatistic( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "type", + } + + class properties: + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def COUNT(cls): + return cls("COUNT") + + @schemas.classproperty + def COUNT_NULL(cls): + return cls("COUNT_NULL") + + @schemas.classproperty + def COUNT_UNIQUE(cls): + return cls("COUNT_UNIQUE") + + @schemas.classproperty + def AVG(cls): + return cls("AVG") + + @schemas.classproperty + def STDDEV(cls): + return cls("STDDEV") + + @schemas.classproperty + def MIN(cls): + return cls("MIN") + + @schemas.classproperty + def MAX(cls): + return cls("MAX") + + @schemas.classproperty + def PERCENTILE_25(cls): + return cls("PERCENTILE_25") + + @schemas.classproperty + def PERCENTILE_50(cls): + return cls("PERCENTILE_50") + + @schemas.classproperty + def PERCENTILE_75(cls): + return cls("PERCENTILE_75") + value = schemas.StrSchema + __annotations__ = { + "type": type, + "value": value, + } + + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["type", "value", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["value"]) -> typing.Union[MetaOapg.properties.value, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["type", "value", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + value: typing.Union[MetaOapg.properties.value, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ColumnStatistic': + return super().__new__( + cls, + *_args, + type=type, + value=value, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/column_statistic_warning.pyi b/gooddata-api-client/gooddata_api_client/model/column_statistic_warning.pyi new file mode 100644 index 000000000..7075298a6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/column_statistic_warning.pyi @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ColumnStatisticWarning( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "action", + "message", + } + + class properties: + action = schemas.StrSchema + message = schemas.StrSchema + __annotations__ = { + "action": action, + "message": message, + } + + action: MetaOapg.properties.action + message: MetaOapg.properties.message + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["action"]) -> MetaOapg.properties.action: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["message"]) -> MetaOapg.properties.message: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["action", "message", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["action"]) -> MetaOapg.properties.action: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["message"]) -> MetaOapg.properties.message: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["action", "message", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + action: typing.Union[MetaOapg.properties.action, str, ], + message: typing.Union[MetaOapg.properties.message, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ColumnStatisticWarning': + return super().__new__( + cls, + *_args, + action=action, + message=message, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/column_statistics_request.pyi b/gooddata-api-client/gooddata_api_client/model/column_statistics_request.pyi new file mode 100644 index 000000000..9fe7a160f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/column_statistics_request.pyi @@ -0,0 +1,239 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ColumnStatisticsRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A request to retrieve statistics for a column. + """ + + + class MetaOapg: + required = { + "from", + "columnName", + } + + class properties: + columnName = schemas.StrSchema + + + class _from( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + SqlQuery, + Table, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> '_from': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @staticmethod + def frequency() -> typing.Type['FrequencyProperties']: + return FrequencyProperties + + @staticmethod + def histogram() -> typing.Type['HistogramProperties']: + return HistogramProperties + + + class statistics( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def COUNT(cls): + return cls("COUNT") + + @schemas.classproperty + def COUNT_NULL(cls): + return cls("COUNT_NULL") + + @schemas.classproperty + def COUNT_UNIQUE(cls): + return cls("COUNT_UNIQUE") + + @schemas.classproperty + def AVG(cls): + return cls("AVG") + + @schemas.classproperty + def STDDEV(cls): + return cls("STDDEV") + + @schemas.classproperty + def MIN(cls): + return cls("MIN") + + @schemas.classproperty + def MAX(cls): + return cls("MAX") + + @schemas.classproperty + def PERCENTILE_25(cls): + return cls("PERCENTILE_25") + + @schemas.classproperty + def PERCENTILE_50(cls): + return cls("PERCENTILE_50") + + @schemas.classproperty + def PERCENTILE_75(cls): + return cls("PERCENTILE_75") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'statistics': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "columnName": columnName, + "from": _from, + "frequency": frequency, + "histogram": histogram, + "statistics": statistics, + } + + columnName: MetaOapg.properties.columnName + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["columnName"]) -> MetaOapg.properties.columnName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["frequency"]) -> 'FrequencyProperties': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["histogram"]) -> 'HistogramProperties': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["statistics"]) -> MetaOapg.properties.statistics: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["columnName", "from", "frequency", "histogram", "statistics", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["columnName"]) -> MetaOapg.properties.columnName: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["frequency"]) -> typing.Union['FrequencyProperties', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["histogram"]) -> typing.Union['HistogramProperties', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["statistics"]) -> typing.Union[MetaOapg.properties.statistics, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["columnName", "from", "frequency", "histogram", "statistics", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + columnName: typing.Union[MetaOapg.properties.columnName, str, ], + frequency: typing.Union['FrequencyProperties', schemas.Unset] = schemas.unset, + histogram: typing.Union['HistogramProperties', schemas.Unset] = schemas.unset, + statistics: typing.Union[MetaOapg.properties.statistics, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ColumnStatisticsRequest': + return super().__new__( + cls, + *_args, + columnName=columnName, + frequency=frequency, + histogram=histogram, + statistics=statistics, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.frequency_properties import FrequencyProperties +from gooddata_api_client.model.histogram_properties import HistogramProperties +from gooddata_api_client.model.sql_query import SqlQuery +from gooddata_api_client.model.table import Table diff --git a/gooddata-api-client/gooddata_api_client/model/column_statistics_response.pyi b/gooddata-api-client/gooddata_api_client/model/column_statistics_response.pyi new file mode 100644 index 000000000..92abf005c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/column_statistics_response.pyi @@ -0,0 +1,170 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ColumnStatisticsResponse( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + @staticmethod + def frequency() -> typing.Type['Frequency']: + return Frequency + + @staticmethod + def histogram() -> typing.Type['Histogram']: + return Histogram + + + class statistics( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ColumnStatistic']: + return ColumnStatistic + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['ColumnStatistic'], typing.List['ColumnStatistic']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'statistics': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ColumnStatistic': + return super().__getitem__(i) + + + class warnings( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ColumnStatisticWarning']: + return ColumnStatisticWarning + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['ColumnStatisticWarning'], typing.List['ColumnStatisticWarning']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'warnings': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ColumnStatisticWarning': + return super().__getitem__(i) + __annotations__ = { + "frequency": frequency, + "histogram": histogram, + "statistics": statistics, + "warnings": warnings, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["frequency"]) -> 'Frequency': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["histogram"]) -> 'Histogram': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["statistics"]) -> MetaOapg.properties.statistics: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["warnings"]) -> MetaOapg.properties.warnings: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["frequency", "histogram", "statistics", "warnings", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["frequency"]) -> typing.Union['Frequency', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["histogram"]) -> typing.Union['Histogram', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["statistics"]) -> typing.Union[MetaOapg.properties.statistics, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["warnings"]) -> typing.Union[MetaOapg.properties.warnings, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["frequency", "histogram", "statistics", "warnings", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + frequency: typing.Union['Frequency', schemas.Unset] = schemas.unset, + histogram: typing.Union['Histogram', schemas.Unset] = schemas.unset, + statistics: typing.Union[MetaOapg.properties.statistics, list, tuple, schemas.Unset] = schemas.unset, + warnings: typing.Union[MetaOapg.properties.warnings, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ColumnStatisticsResponse': + return super().__new__( + cls, + *_args, + frequency=frequency, + histogram=histogram, + statistics=statistics, + warnings=warnings, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.column_statistic import ColumnStatistic +from gooddata_api_client.model.column_statistic_warning import ColumnStatisticWarning +from gooddata_api_client.model.frequency import Frequency +from gooddata_api_client.model.histogram import Histogram diff --git a/gooddata-api-client/gooddata_api_client/model/comparison.pyi b/gooddata-api-client/gooddata_api_client/model/comparison.pyi new file mode 100644 index 000000000..96e7e17e5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/comparison.pyi @@ -0,0 +1,146 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Comparison( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "left", + "right", + "operator", + } + + class properties: + + @staticmethod + def left() -> typing.Type['LocalIdentifier']: + return LocalIdentifier + + + class operator( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def GREATER_THAN(cls): + return cls("GREATER_THAN") + + @schemas.classproperty + def GREATER_THAN_OR_EQUAL_TO(cls): + return cls("GREATER_THAN_OR_EQUAL_TO") + + @schemas.classproperty + def LESS_THAN(cls): + return cls("LESS_THAN") + + @schemas.classproperty + def LESS_THAN_OR_EQUAL_TO(cls): + return cls("LESS_THAN_OR_EQUAL_TO") + + @schemas.classproperty + def EQUAL_TO(cls): + return cls("EQUAL_TO") + + @schemas.classproperty + def NOT_EQUAL_TO(cls): + return cls("NOT_EQUAL_TO") + + @staticmethod + def right() -> typing.Type['AlertConditionOperand']: + return AlertConditionOperand + __annotations__ = { + "left": left, + "operator": operator, + "right": right, + } + + left: 'LocalIdentifier' + right: 'AlertConditionOperand' + operator: MetaOapg.properties.operator + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["left"]) -> 'LocalIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["right"]) -> 'AlertConditionOperand': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["left", "operator", "right", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["left"]) -> 'LocalIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["right"]) -> 'AlertConditionOperand': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["left", "operator", "right", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + left: 'LocalIdentifier', + right: 'AlertConditionOperand', + operator: typing.Union[MetaOapg.properties.operator, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Comparison': + return super().__new__( + cls, + *_args, + left=left, + right=right, + operator=operator, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.alert_condition_operand import AlertConditionOperand +from gooddata_api_client.model.local_identifier import LocalIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/comparison_condition.pyi b/gooddata-api-client/gooddata_api_client/model/comparison_condition.pyi new file mode 100644 index 000000000..811d0aad8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/comparison_condition.pyi @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ComparisonCondition( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Condition that compares the metric value to a given constant value using a comparison operator. + """ + + + class MetaOapg: + required = { + "comparison", + } + + class properties: + + + class comparison( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "value", + "operator", + } + + class properties: + + + class operator( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def GREATER_THAN(cls): + return cls("GREATER_THAN") + + @schemas.classproperty + def GREATER_THAN_OR_EQUAL_TO(cls): + return cls("GREATER_THAN_OR_EQUAL_TO") + + @schemas.classproperty + def LESS_THAN(cls): + return cls("LESS_THAN") + + @schemas.classproperty + def LESS_THAN_OR_EQUAL_TO(cls): + return cls("LESS_THAN_OR_EQUAL_TO") + + @schemas.classproperty + def EQUAL_TO(cls): + return cls("EQUAL_TO") + + @schemas.classproperty + def NOT_EQUAL_TO(cls): + return cls("NOT_EQUAL_TO") + value = schemas.NumberSchema + __annotations__ = { + "operator": operator, + "value": value, + } + + value: MetaOapg.properties.value + operator: MetaOapg.properties.operator + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["operator", "value", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["operator", "value", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + value: typing.Union[MetaOapg.properties.value, decimal.Decimal, int, float, ], + operator: typing.Union[MetaOapg.properties.operator, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'comparison': + return super().__new__( + cls, + *_args, + value=value, + operator=operator, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "comparison": comparison, + } + + comparison: MetaOapg.properties.comparison + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["comparison"]) -> MetaOapg.properties.comparison: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["comparison", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["comparison"]) -> MetaOapg.properties.comparison: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["comparison", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + comparison: typing.Union[MetaOapg.properties.comparison, dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ComparisonCondition': + return super().__new__( + cls, + *_args, + comparison=comparison, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/comparison_wrapper.pyi b/gooddata-api-client/gooddata_api_client/model/comparison_wrapper.pyi new file mode 100644 index 000000000..18d8f866a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/comparison_wrapper.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ComparisonWrapper( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "comparison", + } + + class properties: + + @staticmethod + def comparison() -> typing.Type['Comparison']: + return Comparison + __annotations__ = { + "comparison": comparison, + } + + comparison: 'Comparison' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["comparison"]) -> 'Comparison': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["comparison", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["comparison"]) -> 'Comparison': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["comparison", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + comparison: 'Comparison', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ComparisonWrapper': + return super().__new__( + cls, + *_args, + comparison=comparison, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.comparison import Comparison diff --git a/gooddata-api-client/gooddata_api_client/model/compound_measure_value_filter.pyi b/gooddata-api-client/gooddata_api_client/model/compound_measure_value_filter.pyi new file mode 100644 index 000000000..80fd1e943 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/compound_measure_value_filter.pyi @@ -0,0 +1,248 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class CompoundMeasureValueFilter( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Filter the result by applying multiple comparison and/or range conditions combined with OR logic. If conditions list is empty, no filtering is applied (all rows are returned). + """ + + + class MetaOapg: + required = { + "compoundMeasureValueFilter", + } + + class properties: + + + class compoundMeasureValueFilter( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "measure", + "conditions", + } + + class properties: + applyOnResult = schemas.BoolSchema + + + class conditions( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['MeasureValueCondition']: + return MeasureValueCondition + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['MeasureValueCondition'], typing.List['MeasureValueCondition']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'conditions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'MeasureValueCondition': + return super().__getitem__(i) + + + class dimensionality( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AfmIdentifier']: + return AfmIdentifier + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AfmIdentifier'], typing.List['AfmIdentifier']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dimensionality': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AfmIdentifier': + return super().__getitem__(i) + localIdentifier = schemas.StrSchema + + @staticmethod + def measure() -> typing.Type['AfmIdentifier']: + return AfmIdentifier + treatNullValuesAs = schemas.NumberSchema + __annotations__ = { + "applyOnResult": applyOnResult, + "conditions": conditions, + "dimensionality": dimensionality, + "localIdentifier": localIdentifier, + "measure": measure, + "treatNullValuesAs": treatNullValuesAs, + } + + measure: 'AfmIdentifier' + conditions: MetaOapg.properties.conditions + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["applyOnResult"]) -> MetaOapg.properties.applyOnResult: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["conditions"]) -> MetaOapg.properties.conditions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dimensionality"]) -> MetaOapg.properties.dimensionality: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["measure"]) -> 'AfmIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["treatNullValuesAs"]) -> MetaOapg.properties.treatNullValuesAs: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "conditions", "dimensionality", "localIdentifier", "measure", "treatNullValuesAs", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["applyOnResult"]) -> typing.Union[MetaOapg.properties.applyOnResult, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["conditions"]) -> MetaOapg.properties.conditions: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dimensionality"]) -> typing.Union[MetaOapg.properties.dimensionality, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["localIdentifier"]) -> typing.Union[MetaOapg.properties.localIdentifier, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["measure"]) -> 'AfmIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["treatNullValuesAs"]) -> typing.Union[MetaOapg.properties.treatNullValuesAs, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "conditions", "dimensionality", "localIdentifier", "measure", "treatNullValuesAs", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + measure: 'AfmIdentifier', + conditions: typing.Union[MetaOapg.properties.conditions, list, tuple, ], + applyOnResult: typing.Union[MetaOapg.properties.applyOnResult, bool, schemas.Unset] = schemas.unset, + dimensionality: typing.Union[MetaOapg.properties.dimensionality, list, tuple, schemas.Unset] = schemas.unset, + localIdentifier: typing.Union[MetaOapg.properties.localIdentifier, str, schemas.Unset] = schemas.unset, + treatNullValuesAs: typing.Union[MetaOapg.properties.treatNullValuesAs, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'compoundMeasureValueFilter': + return super().__new__( + cls, + *_args, + measure=measure, + conditions=conditions, + applyOnResult=applyOnResult, + dimensionality=dimensionality, + localIdentifier=localIdentifier, + treatNullValuesAs=treatNullValuesAs, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "compoundMeasureValueFilter": compoundMeasureValueFilter, + } + + compoundMeasureValueFilter: MetaOapg.properties.compoundMeasureValueFilter + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["compoundMeasureValueFilter"]) -> MetaOapg.properties.compoundMeasureValueFilter: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["compoundMeasureValueFilter", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["compoundMeasureValueFilter"]) -> MetaOapg.properties.compoundMeasureValueFilter: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["compoundMeasureValueFilter", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + compoundMeasureValueFilter: typing.Union[MetaOapg.properties.compoundMeasureValueFilter, dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'CompoundMeasureValueFilter': + return super().__new__( + cls, + *_args, + compoundMeasureValueFilter=compoundMeasureValueFilter, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.afm_identifier import AfmIdentifier +from gooddata_api_client.model.measure_value_condition import MeasureValueCondition diff --git a/gooddata-api-client/gooddata_api_client/model/content_slide_template.pyi b/gooddata-api-client/gooddata_api_client/model/content_slide_template.pyi new file mode 100644 index 000000000..126985a7b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/content_slide_template.pyi @@ -0,0 +1,132 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ContentSlideTemplate( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Settings for content slide. + """ + + + class MetaOapg: + + class properties: + + + class descriptionField( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'descriptionField': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + @staticmethod + def footer() -> typing.Type['RunningSection']: + return RunningSection + + @staticmethod + def header() -> typing.Type['RunningSection']: + return RunningSection + __annotations__ = { + "descriptionField": descriptionField, + "footer": footer, + "header": header, + } + + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["descriptionField"]) -> MetaOapg.properties.descriptionField: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["footer"]) -> 'RunningSection': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["header"]) -> 'RunningSection': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["descriptionField", "footer", "header", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["descriptionField"]) -> typing.Union[MetaOapg.properties.descriptionField, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["footer"]) -> typing.Union['RunningSection', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["header"]) -> typing.Union['RunningSection', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["descriptionField", "footer", "header", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + descriptionField: typing.Union[MetaOapg.properties.descriptionField, None, str, schemas.Unset] = schemas.unset, + footer: typing.Union['RunningSection', schemas.Unset] = schemas.unset, + header: typing.Union['RunningSection', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ContentSlideTemplate': + return super().__new__( + cls, + *_args, + descriptionField=descriptionField, + footer=footer, + header=header, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.running_section import RunningSection diff --git a/gooddata-api-client/gooddata_api_client/model/cover_slide_template.pyi b/gooddata-api-client/gooddata_api_client/model/cover_slide_template.pyi new file mode 100644 index 000000000..39222b415 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/cover_slide_template.pyi @@ -0,0 +1,142 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class CoverSlideTemplate( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Settings for cover slide. + """ + + + class MetaOapg: + + class properties: + backgroundImage = schemas.BoolSchema + + + class descriptionField( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'descriptionField': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + @staticmethod + def footer() -> typing.Type['RunningSection']: + return RunningSection + + @staticmethod + def header() -> typing.Type['RunningSection']: + return RunningSection + __annotations__ = { + "backgroundImage": backgroundImage, + "descriptionField": descriptionField, + "footer": footer, + "header": header, + } + + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["backgroundImage"]) -> MetaOapg.properties.backgroundImage: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["descriptionField"]) -> MetaOapg.properties.descriptionField: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["footer"]) -> 'RunningSection': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["header"]) -> 'RunningSection': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["backgroundImage", "descriptionField", "footer", "header", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["backgroundImage"]) -> typing.Union[MetaOapg.properties.backgroundImage, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["descriptionField"]) -> typing.Union[MetaOapg.properties.descriptionField, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["footer"]) -> typing.Union['RunningSection', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["header"]) -> typing.Union['RunningSection', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["backgroundImage", "descriptionField", "footer", "header", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + backgroundImage: typing.Union[MetaOapg.properties.backgroundImage, bool, schemas.Unset] = schemas.unset, + descriptionField: typing.Union[MetaOapg.properties.descriptionField, None, str, schemas.Unset] = schemas.unset, + footer: typing.Union['RunningSection', schemas.Unset] = schemas.unset, + header: typing.Union['RunningSection', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'CoverSlideTemplate': + return super().__new__( + cls, + *_args, + backgroundImage=backgroundImage, + descriptionField=descriptionField, + footer=footer, + header=header, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.running_section import RunningSection diff --git a/gooddata-api-client/gooddata_api_client/model/create_knowledge_document_request_dto.py b/gooddata-api-client/gooddata_api_client/model/create_knowledge_document_request_dto.py new file mode 100644 index 000000000..7271da96c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/create_knowledge_document_request_dto.py @@ -0,0 +1,288 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class CreateKnowledgeDocumentRequestDto(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'content': (str,), # noqa: E501 + 'filename': (str,), # noqa: E501 + 'page_boundaries': ([int],), # noqa: E501 + 'scopes': ([str],), # noqa: E501 + 'title': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'filename': 'filename', # noqa: E501 + 'page_boundaries': 'pageBoundaries', # noqa: E501 + 'scopes': 'scopes', # noqa: E501 + 'title': 'title', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, filename, *args, **kwargs): # noqa: E501 + """CreateKnowledgeDocumentRequestDto - a model defined in OpenAPI + + Args: + content (str): + filename (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,) + page_boundaries ([int]): [optional] # noqa: E501 + scopes ([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__,) + + self.content = content + self.filename = filename + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = 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, filename, *args, **kwargs): # noqa: E501 + """CreateKnowledgeDocumentRequestDto - a model defined in OpenAPI + + Args: + content (str): + filename (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,) + page_boundaries ([int]): [optional] # noqa: E501 + scopes ([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__,) + + self.content = content + self.filename = filename + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/create_knowledge_document_request_dto.pyi b/gooddata-api-client/gooddata_api_client/model/create_knowledge_document_request_dto.pyi new file mode 100644 index 000000000..664f6b07a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/create_knowledge_document_request_dto.pyi @@ -0,0 +1,170 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class CreateKnowledgeDocumentRequestDto( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "filename", + "content", + } + + class properties: + content = schemas.StrSchema + filename = schemas.StrSchema + + + class pageBoundaries( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.Int32Schema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, decimal.Decimal, int, ]], typing.List[typing.Union[MetaOapg.items, decimal.Decimal, int, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'pageBoundaries': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class scopes( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'scopes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + __annotations__ = { + "content": content, + "filename": filename, + "pageBoundaries": pageBoundaries, + "scopes": scopes, + "title": title, + } + + filename: MetaOapg.properties.filename + content: MetaOapg.properties.content + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filename"]) -> MetaOapg.properties.filename: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["pageBoundaries"]) -> MetaOapg.properties.pageBoundaries: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["scopes"]) -> MetaOapg.properties.scopes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["content", "filename", "pageBoundaries", "scopes", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filename"]) -> MetaOapg.properties.filename: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["pageBoundaries"]) -> typing.Union[MetaOapg.properties.pageBoundaries, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["scopes"]) -> typing.Union[MetaOapg.properties.scopes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["content", "filename", "pageBoundaries", "scopes", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + filename: typing.Union[MetaOapg.properties.filename, str, ], + content: typing.Union[MetaOapg.properties.content, str, ], + pageBoundaries: typing.Union[MetaOapg.properties.pageBoundaries, list, tuple, schemas.Unset] = schemas.unset, + scopes: typing.Union[MetaOapg.properties.scopes, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'CreateKnowledgeDocumentRequestDto': + return super().__new__( + cls, + *_args, + filename=filename, + content=content, + pageBoundaries=pageBoundaries, + scopes=scopes, + title=title, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/create_knowledge_document_response_dto.py b/gooddata-api-client/gooddata_api_client/model/create_knowledge_document_response_dto.py new file mode 100644 index 000000000..be932eab3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/create_knowledge_document_response_dto.py @@ -0,0 +1,288 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class CreateKnowledgeDocumentResponseDto(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'filename': (str,), # noqa: E501 + 'message': (str,), # noqa: E501 + 'num_chunks': (int,), # noqa: E501 + 'success': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'filename': 'filename', # noqa: E501 + 'message': 'message', # noqa: E501 + 'num_chunks': 'numChunks', # noqa: E501 + 'success': 'success', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, filename, message, num_chunks, success, *args, **kwargs): # noqa: E501 + """CreateKnowledgeDocumentResponseDto - a model defined in OpenAPI + + Args: + filename (str): + message (str): + num_chunks (int): + success (bool): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.filename = filename + self.message = message + self.num_chunks = num_chunks + self.success = success + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, filename, message, num_chunks, success, *args, **kwargs): # noqa: E501 + """CreateKnowledgeDocumentResponseDto - a model defined in OpenAPI + + Args: + filename (str): + message (str): + num_chunks (int): + success (bool): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.filename = filename + self.message = message + self.num_chunks = num_chunks + self.success = success + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/create_knowledge_document_response_dto.pyi b/gooddata-api-client/gooddata_api_client/model/create_knowledge_document_response_dto.pyi new file mode 100644 index 000000000..0cf893679 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/create_knowledge_document_response_dto.pyi @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class CreateKnowledgeDocumentResponseDto( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "numChunks", + "filename", + "success", + "message", + } + + class properties: + filename = schemas.StrSchema + message = schemas.StrSchema + numChunks = schemas.Int32Schema + success = schemas.BoolSchema + __annotations__ = { + "filename": filename, + "message": message, + "numChunks": numChunks, + "success": success, + } + + numChunks: MetaOapg.properties.numChunks + filename: MetaOapg.properties.filename + success: MetaOapg.properties.success + message: MetaOapg.properties.message + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filename"]) -> MetaOapg.properties.filename: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["message"]) -> MetaOapg.properties.message: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["numChunks"]) -> MetaOapg.properties.numChunks: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["success"]) -> MetaOapg.properties.success: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["filename", "message", "numChunks", "success", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filename"]) -> MetaOapg.properties.filename: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["message"]) -> MetaOapg.properties.message: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["numChunks"]) -> MetaOapg.properties.numChunks: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["success"]) -> MetaOapg.properties.success: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["filename", "message", "numChunks", "success", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + numChunks: typing.Union[MetaOapg.properties.numChunks, decimal.Decimal, int, ], + filename: typing.Union[MetaOapg.properties.filename, str, ], + success: typing.Union[MetaOapg.properties.success, bool, ], + message: typing.Union[MetaOapg.properties.message, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'CreateKnowledgeDocumentResponseDto': + return super().__new__( + cls, + *_args, + numChunks=numChunks, + filename=filename, + success=success, + message=message, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/created_visualization.py b/gooddata-api-client/gooddata_api_client/model/created_visualization.py index ca10ad91e..37cb0b068 100644 --- a/gooddata-api-client/gooddata_api_client/model/created_visualization.py +++ b/gooddata-api-client/gooddata_api_client/model/created_visualization.py @@ -35,10 +35,12 @@ def lazy_import(): 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): @@ -73,6 +75,7 @@ class CreatedVisualization(ModelNormal): 'LINE': "LINE", 'PIE': "PIE", 'COLUMN': "COLUMN", + 'SCATTER': "SCATTER", }, } @@ -109,6 +112,7 @@ def openapi_types(): 'suggestions': ([Suggestion],), # noqa: E501 'title': (str,), # noqa: E501 'visualization_type': (str,), # noqa: E501 + 'config': (VisualizationConfig,), # noqa: E501 'saved_visualization_id': (str,), # noqa: E501 } @@ -125,6 +129,7 @@ def discriminator(): 'suggestions': 'suggestions', # noqa: E501 'title': 'title', # noqa: E501 'visualization_type': 'visualizationType', # noqa: E501 + 'config': 'config', # noqa: E501 'saved_visualization_id': 'savedVisualizationId', # noqa: E501 } @@ -178,6 +183,7 @@ 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 """ @@ -280,6 +286,7 @@ 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 """ diff --git a/gooddata-api-client/gooddata_api_client/model/created_visualization.pyi b/gooddata-api-client/gooddata_api_client/model/created_visualization.pyi new file mode 100644 index 000000000..dab2d448c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/created_visualization.pyi @@ -0,0 +1,360 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class CreatedVisualization( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + List of created visualization objects + """ + + + class MetaOapg: + required = { + "dimensionality", + "visualizationType", + "suggestions", + "filters", + "id", + "metrics", + "title", + } + + class properties: + + + class dimensionality( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DimAttribute']: + return DimAttribute + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DimAttribute'], typing.List['DimAttribute']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dimensionality': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DimAttribute': + return super().__getitem__(i) + + + class filters( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AttributeNegativeFilter, + AttributePositiveFilter, + DateAbsoluteFilter, + DateRelativeFilter, + RankingFilter, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'filters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + id = schemas.StrSchema + + + class metrics( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['Metric']: + return Metric + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['Metric'], typing.List['Metric']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'metrics': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'Metric': + return super().__getitem__(i) + + + class suggestions( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['Suggestion']: + return Suggestion + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['Suggestion'], typing.List['Suggestion']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'suggestions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'Suggestion': + return super().__getitem__(i) + title = schemas.StrSchema + + + class visualizationType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def TABLE(cls): + return cls("TABLE") + + @schemas.classproperty + def HEADLINE(cls): + return cls("HEADLINE") + + @schemas.classproperty + def BAR(cls): + return cls("BAR") + + @schemas.classproperty + def LINE(cls): + return cls("LINE") + + @schemas.classproperty + def PIE(cls): + return cls("PIE") + + @schemas.classproperty + def COLUMN(cls): + return cls("COLUMN") + + @schemas.classproperty + def SCATTER(cls): + return cls("SCATTER") + + @staticmethod + def config() -> typing.Type['VisualizationConfig']: + return VisualizationConfig + savedVisualizationId = schemas.StrSchema + __annotations__ = { + "dimensionality": dimensionality, + "filters": filters, + "id": id, + "metrics": metrics, + "suggestions": suggestions, + "title": title, + "visualizationType": visualizationType, + "config": config, + "savedVisualizationId": savedVisualizationId, + } + + dimensionality: MetaOapg.properties.dimensionality + visualizationType: MetaOapg.properties.visualizationType + suggestions: MetaOapg.properties.suggestions + filters: MetaOapg.properties.filters + id: MetaOapg.properties.id + metrics: MetaOapg.properties.metrics + title: MetaOapg.properties.title + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dimensionality"]) -> MetaOapg.properties.dimensionality: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["suggestions"]) -> MetaOapg.properties.suggestions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualizationType"]) -> MetaOapg.properties.visualizationType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["config"]) -> 'VisualizationConfig': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["savedVisualizationId"]) -> MetaOapg.properties.savedVisualizationId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dimensionality", "filters", "id", "metrics", "suggestions", "title", "visualizationType", "config", "savedVisualizationId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dimensionality"]) -> MetaOapg.properties.dimensionality: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["suggestions"]) -> MetaOapg.properties.suggestions: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualizationType"]) -> MetaOapg.properties.visualizationType: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["config"]) -> typing.Union['VisualizationConfig', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["savedVisualizationId"]) -> typing.Union[MetaOapg.properties.savedVisualizationId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dimensionality", "filters", "id", "metrics", "suggestions", "title", "visualizationType", "config", "savedVisualizationId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + dimensionality: typing.Union[MetaOapg.properties.dimensionality, list, tuple, ], + visualizationType: typing.Union[MetaOapg.properties.visualizationType, str, ], + suggestions: typing.Union[MetaOapg.properties.suggestions, list, tuple, ], + filters: typing.Union[MetaOapg.properties.filters, list, tuple, ], + id: typing.Union[MetaOapg.properties.id, str, ], + metrics: typing.Union[MetaOapg.properties.metrics, list, tuple, ], + title: typing.Union[MetaOapg.properties.title, str, ], + config: typing.Union['VisualizationConfig', schemas.Unset] = schemas.unset, + savedVisualizationId: typing.Union[MetaOapg.properties.savedVisualizationId, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'CreatedVisualization': + return super().__new__( + cls, + *_args, + dimensionality=dimensionality, + visualizationType=visualizationType, + suggestions=suggestions, + filters=filters, + id=id, + metrics=metrics, + title=title, + config=config, + savedVisualizationId=savedVisualizationId, + _configuration=_configuration, + **kwargs, + ) + +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.dim_attribute import DimAttribute +from gooddata_api_client.model.metric import Metric +from gooddata_api_client.model.ranking_filter import RankingFilter +from gooddata_api_client.model.suggestion import Suggestion +from gooddata_api_client.model.visualization_config import VisualizationConfig diff --git a/gooddata-api-client/gooddata_api_client/model/created_visualizations.pyi b/gooddata-api-client/gooddata_api_client/model/created_visualizations.pyi new file mode 100644 index 000000000..02b2dabb4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/created_visualizations.pyi @@ -0,0 +1,163 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class CreatedVisualizations( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Visualization definitions created by AI. + """ + + + class MetaOapg: + required = { + "objects", + "reasoning", + "suggestions", + } + + class properties: + + + class objects( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['CreatedVisualization']: + return CreatedVisualization + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['CreatedVisualization'], typing.List['CreatedVisualization']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'objects': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'CreatedVisualization': + return super().__getitem__(i) + reasoning = schemas.StrSchema + + + class suggestions( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['Suggestion']: + return Suggestion + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['Suggestion'], typing.List['Suggestion']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'suggestions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'Suggestion': + return super().__getitem__(i) + __annotations__ = { + "objects": objects, + "reasoning": reasoning, + "suggestions": suggestions, + } + + objects: MetaOapg.properties.objects + reasoning: MetaOapg.properties.reasoning + suggestions: MetaOapg.properties.suggestions + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["objects"]) -> MetaOapg.properties.objects: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["reasoning"]) -> MetaOapg.properties.reasoning: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["suggestions"]) -> MetaOapg.properties.suggestions: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["objects", "reasoning", "suggestions", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["objects"]) -> MetaOapg.properties.objects: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["reasoning"]) -> MetaOapg.properties.reasoning: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["suggestions"]) -> MetaOapg.properties.suggestions: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["objects", "reasoning", "suggestions", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + objects: typing.Union[MetaOapg.properties.objects, list, tuple, ], + reasoning: typing.Union[MetaOapg.properties.reasoning, str, ], + suggestions: typing.Union[MetaOapg.properties.suggestions, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'CreatedVisualizations': + return super().__new__( + cls, + *_args, + objects=objects, + reasoning=reasoning, + suggestions=suggestions, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.created_visualization import CreatedVisualization +from gooddata_api_client.model.suggestion import Suggestion diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_attribute_filter.pyi b/gooddata-api-client/gooddata_api_client/model/dashboard_attribute_filter.pyi new file mode 100644 index 000000000..fe9370dcc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_attribute_filter.pyi @@ -0,0 +1,321 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DashboardAttributeFilter( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "attributeFilter", + } + + class properties: + + + class attributeFilter( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "negativeSelection", + "displayForm", + "attributeElements", + } + + class properties: + + @staticmethod + def attributeElements() -> typing.Type['AttributeElements']: + return AttributeElements + + @staticmethod + def displayForm() -> typing.Type['IdentifierRef']: + return IdentifierRef + + + class filterElementsBy( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AttributeFilterParent']: + return AttributeFilterParent + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AttributeFilterParent'], typing.List['AttributeFilterParent']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'filterElementsBy': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AttributeFilterParent': + return super().__getitem__(i) + + + class filterElementsByDate( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AttributeFilterByDate']: + return AttributeFilterByDate + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AttributeFilterByDate'], typing.List['AttributeFilterByDate']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'filterElementsByDate': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AttributeFilterByDate': + return super().__getitem__(i) + localIdentifier = schemas.StrSchema + negativeSelection = schemas.BoolSchema + + + class selectionMode( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SINGLE(cls): + return cls("single") + + @schemas.classproperty + def MULTI(cls): + return cls("multi") + title = schemas.StrSchema + + + class validateElementsBy( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['IdentifierRef']: + return IdentifierRef + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['IdentifierRef'], typing.List['IdentifierRef']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'validateElementsBy': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'IdentifierRef': + return super().__getitem__(i) + __annotations__ = { + "attributeElements": attributeElements, + "displayForm": displayForm, + "filterElementsBy": filterElementsBy, + "filterElementsByDate": filterElementsByDate, + "localIdentifier": localIdentifier, + "negativeSelection": negativeSelection, + "selectionMode": selectionMode, + "title": title, + "validateElementsBy": validateElementsBy, + } + + negativeSelection: MetaOapg.properties.negativeSelection + displayForm: 'IdentifierRef' + attributeElements: 'AttributeElements' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributeElements"]) -> 'AttributeElements': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["displayForm"]) -> 'IdentifierRef': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filterElementsBy"]) -> MetaOapg.properties.filterElementsBy: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filterElementsByDate"]) -> MetaOapg.properties.filterElementsByDate: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["negativeSelection"]) -> MetaOapg.properties.negativeSelection: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["selectionMode"]) -> MetaOapg.properties.selectionMode: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["validateElementsBy"]) -> MetaOapg.properties.validateElementsBy: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributeElements", "displayForm", "filterElementsBy", "filterElementsByDate", "localIdentifier", "negativeSelection", "selectionMode", "title", "validateElementsBy", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributeElements"]) -> 'AttributeElements': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["displayForm"]) -> 'IdentifierRef': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filterElementsBy"]) -> typing.Union[MetaOapg.properties.filterElementsBy, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filterElementsByDate"]) -> typing.Union[MetaOapg.properties.filterElementsByDate, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["localIdentifier"]) -> typing.Union[MetaOapg.properties.localIdentifier, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["negativeSelection"]) -> MetaOapg.properties.negativeSelection: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["selectionMode"]) -> typing.Union[MetaOapg.properties.selectionMode, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["validateElementsBy"]) -> typing.Union[MetaOapg.properties.validateElementsBy, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributeElements", "displayForm", "filterElementsBy", "filterElementsByDate", "localIdentifier", "negativeSelection", "selectionMode", "title", "validateElementsBy", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + negativeSelection: typing.Union[MetaOapg.properties.negativeSelection, bool, ], + displayForm: 'IdentifierRef', + attributeElements: 'AttributeElements', + filterElementsBy: typing.Union[MetaOapg.properties.filterElementsBy, list, tuple, schemas.Unset] = schemas.unset, + filterElementsByDate: typing.Union[MetaOapg.properties.filterElementsByDate, list, tuple, schemas.Unset] = schemas.unset, + localIdentifier: typing.Union[MetaOapg.properties.localIdentifier, str, schemas.Unset] = schemas.unset, + selectionMode: typing.Union[MetaOapg.properties.selectionMode, str, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + validateElementsBy: typing.Union[MetaOapg.properties.validateElementsBy, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributeFilter': + return super().__new__( + cls, + *_args, + negativeSelection=negativeSelection, + displayForm=displayForm, + attributeElements=attributeElements, + filterElementsBy=filterElementsBy, + filterElementsByDate=filterElementsByDate, + localIdentifier=localIdentifier, + selectionMode=selectionMode, + title=title, + validateElementsBy=validateElementsBy, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "attributeFilter": attributeFilter, + } + + attributeFilter: MetaOapg.properties.attributeFilter + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributeFilter"]) -> MetaOapg.properties.attributeFilter: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributeFilter", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributeFilter"]) -> MetaOapg.properties.attributeFilter: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributeFilter", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributeFilter: typing.Union[MetaOapg.properties.attributeFilter, dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DashboardAttributeFilter': + return super().__new__( + cls, + *_args, + attributeFilter=attributeFilter, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.attribute_elements import AttributeElements +from gooddata_api_client.model.attribute_filter_by_date import AttributeFilterByDate +from gooddata_api_client.model.attribute_filter_parent import AttributeFilterParent +from gooddata_api_client.model.identifier_ref import IdentifierRef diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter.pyi b/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter.pyi new file mode 100644 index 000000000..19b36af0b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter.pyi @@ -0,0 +1,445 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DashboardDateFilter( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "dateFilter", + } + + class properties: + + + class dateFilter( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "granularity", + "type", + } + + class properties: + + @staticmethod + def attribute() -> typing.Type['IdentifierRef']: + return IdentifierRef + + @staticmethod + def boundedFilter() -> typing.Type['RelativeBoundedDateFilter']: + return RelativeBoundedDateFilter + + @staticmethod + def dataSet() -> typing.Type['IdentifierRef']: + return IdentifierRef + + + class emptyValueHandling( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INCLUDE(cls): + return cls("INCLUDE") + + @schemas.classproperty + def EXCLUDE(cls): + return cls("EXCLUDE") + + @schemas.classproperty + def ONLY(cls): + return cls("ONLY") + + + class _from( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.Int32Schema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> '_from': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class granularity( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ALL_TIME_GRANULARITY(cls): + return cls("ALL_TIME_GRANULARITY") + + @schemas.classproperty + def GDC_TIME_YEAR(cls): + return cls("GDC.time.year") + + @schemas.classproperty + def GDC_TIME_WEEK_US(cls): + return cls("GDC.time.week_us") + + @schemas.classproperty + def GDC_TIME_WEEK_IN_YEAR(cls): + return cls("GDC.time.week_in_year") + + @schemas.classproperty + def GDC_TIME_WEEK_IN_QUARTER(cls): + return cls("GDC.time.week_in_quarter") + + @schemas.classproperty + def GDC_TIME_WEEK(cls): + return cls("GDC.time.week") + + @schemas.classproperty + def GDC_TIME_EUWEEK_IN_YEAR(cls): + return cls("GDC.time.euweek_in_year") + + @schemas.classproperty + def GDC_TIME_EUWEEK_IN_QUARTER(cls): + return cls("GDC.time.euweek_in_quarter") + + @schemas.classproperty + def GDC_TIME_QUARTER(cls): + return cls("GDC.time.quarter") + + @schemas.classproperty + def GDC_TIME_QUARTER_IN_YEAR(cls): + return cls("GDC.time.quarter_in_year") + + @schemas.classproperty + def GDC_TIME_MONTH(cls): + return cls("GDC.time.month") + + @schemas.classproperty + def GDC_TIME_MONTH_IN_QUARTER(cls): + return cls("GDC.time.month_in_quarter") + + @schemas.classproperty + def GDC_TIME_MONTH_IN_YEAR(cls): + return cls("GDC.time.month_in_year") + + @schemas.classproperty + def GDC_TIME_DAY_IN_YEAR(cls): + return cls("GDC.time.day_in_year") + + @schemas.classproperty + def GDC_TIME_DAY_IN_QUARTER(cls): + return cls("GDC.time.day_in_quarter") + + @schemas.classproperty + def GDC_TIME_DAY_IN_MONTH(cls): + return cls("GDC.time.day_in_month") + + @schemas.classproperty + def GDC_TIME_DAY_IN_WEEK(cls): + return cls("GDC.time.day_in_week") + + @schemas.classproperty + def GDC_TIME_DAY_IN_EUWEEK(cls): + return cls("GDC.time.day_in_euweek") + + @schemas.classproperty + def GDC_TIME_DATE(cls): + return cls("GDC.time.date") + + @schemas.classproperty + def GDC_TIME_HOUR(cls): + return cls("GDC.time.hour") + + @schemas.classproperty + def GDC_TIME_HOUR_IN_DAY(cls): + return cls("GDC.time.hour_in_day") + + @schemas.classproperty + def GDC_TIME_MINUTE(cls): + return cls("GDC.time.minute") + + @schemas.classproperty + def GDC_TIME_MINUTE_IN_HOUR(cls): + return cls("GDC.time.minute_in_hour") + + @schemas.classproperty + def GDC_TIME_FISCAL_MONTH(cls): + return cls("GDC.time.fiscal_month") + + @schemas.classproperty + def GDC_TIME_FISCAL_QUARTER(cls): + return cls("GDC.time.fiscal_quarter") + + @schemas.classproperty + def GDC_TIME_FISCAL_YEAR(cls): + return cls("GDC.time.fiscal_year") + localIdentifier = schemas.StrSchema + + + class to( + schemas.ComposedSchema, + ): + + + class MetaOapg: + one_of_0 = schemas.StrSchema + one_of_1 = schemas.Int32Schema + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + cls.one_of_0, + cls.one_of_1, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'to': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def RELATIVE(cls): + return cls("relative") + + @schemas.classproperty + def ABSOLUTE(cls): + return cls("absolute") + __annotations__ = { + "attribute": attribute, + "boundedFilter": boundedFilter, + "dataSet": dataSet, + "emptyValueHandling": emptyValueHandling, + "from": _from, + "granularity": granularity, + "localIdentifier": localIdentifier, + "to": to, + "type": type, + } + + granularity: MetaOapg.properties.granularity + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attribute"]) -> 'IdentifierRef': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["boundedFilter"]) -> 'RelativeBoundedDateFilter': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataSet"]) -> 'IdentifierRef': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["emptyValueHandling"]) -> MetaOapg.properties.emptyValueHandling: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> MetaOapg.properties.to: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attribute", "boundedFilter", "dataSet", "emptyValueHandling", "from", "granularity", "localIdentifier", "to", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attribute"]) -> typing.Union['IdentifierRef', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["boundedFilter"]) -> typing.Union['RelativeBoundedDateFilter', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataSet"]) -> typing.Union['IdentifierRef', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["emptyValueHandling"]) -> typing.Union[MetaOapg.properties.emptyValueHandling, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> typing.Union[MetaOapg.properties._from, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["localIdentifier"]) -> typing.Union[MetaOapg.properties.localIdentifier, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> typing.Union[MetaOapg.properties.to, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attribute", "boundedFilter", "dataSet", "emptyValueHandling", "from", "granularity", "localIdentifier", "to", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + granularity: typing.Union[MetaOapg.properties.granularity, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attribute: typing.Union['IdentifierRef', schemas.Unset] = schemas.unset, + boundedFilter: typing.Union['RelativeBoundedDateFilter', schemas.Unset] = schemas.unset, + dataSet: typing.Union['IdentifierRef', schemas.Unset] = schemas.unset, + emptyValueHandling: typing.Union[MetaOapg.properties.emptyValueHandling, str, schemas.Unset] = schemas.unset, + localIdentifier: typing.Union[MetaOapg.properties.localIdentifier, str, schemas.Unset] = schemas.unset, + to: typing.Union[MetaOapg.properties.to, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'dateFilter': + return super().__new__( + cls, + *_args, + granularity=granularity, + type=type, + attribute=attribute, + boundedFilter=boundedFilter, + dataSet=dataSet, + emptyValueHandling=emptyValueHandling, + localIdentifier=localIdentifier, + to=to, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "dateFilter": dateFilter, + } + + dateFilter: MetaOapg.properties.dateFilter + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dateFilter"]) -> MetaOapg.properties.dateFilter: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dateFilter", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dateFilter"]) -> MetaOapg.properties.dateFilter: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dateFilter", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + dateFilter: typing.Union[MetaOapg.properties.dateFilter, dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DashboardDateFilter': + return super().__new__( + cls, + *_args, + dateFilter=dateFilter, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.identifier_ref import IdentifierRef +from gooddata_api_client.model.relative_bounded_date_filter import RelativeBoundedDateFilter diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter.py b/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter.py index d3c3f8b0d..9c8cd7287 100644 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter.py @@ -96,6 +96,11 @@ class DashboardDateFilterDateFilter(ModelNormal): 'RELATIVE': "relative", 'ABSOLUTE': "absolute", }, + ('empty_value_handling',): { + 'INCLUDE': "INCLUDE", + 'EXCLUDE': "EXCLUDE", + 'ONLY': "ONLY", + }, } validations = { @@ -129,6 +134,7 @@ def openapi_types(): 'attribute': (IdentifierRef,), # noqa: E501 'bounded_filter': (RelativeBoundedDateFilter,), # noqa: E501 'data_set': (IdentifierRef,), # noqa: E501 + 'empty_value_handling': (str,), # noqa: E501 '_from': (AacDashboardFilterFrom,), # noqa: E501 'local_identifier': (str,), # noqa: E501 'to': (AacDashboardFilterFrom,), # noqa: E501 @@ -145,6 +151,7 @@ def discriminator(): 'attribute': 'attribute', # noqa: E501 'bounded_filter': 'boundedFilter', # noqa: E501 'data_set': 'dataSet', # noqa: E501 + 'empty_value_handling': 'emptyValueHandling', # noqa: E501 '_from': 'from', # noqa: E501 'local_identifier': 'localIdentifier', # noqa: E501 'to': 'to', # noqa: E501 @@ -198,6 +205,7 @@ def _from_openapi_data(cls, granularity, type, *args, **kwargs): # noqa: E501 attribute (IdentifierRef): [optional] # noqa: E501 bounded_filter (RelativeBoundedDateFilter): [optional] # noqa: E501 data_set (IdentifierRef): [optional] # noqa: E501 + empty_value_handling (str): [optional] # noqa: E501 _from (AacDashboardFilterFrom): [optional] # noqa: E501 local_identifier (str): [optional] # noqa: E501 to (AacDashboardFilterFrom): [optional] # noqa: E501 @@ -295,6 +303,7 @@ def __init__(self, granularity, type, *args, **kwargs): # noqa: E501 attribute (IdentifierRef): [optional] # noqa: E501 bounded_filter (RelativeBoundedDateFilter): [optional] # noqa: E501 data_set (IdentifierRef): [optional] # noqa: E501 + empty_value_handling (str): [optional] # noqa: E501 _from (AacDashboardFilterFrom): [optional] # noqa: E501 local_identifier (str): [optional] # noqa: E501 to (AacDashboardFilterFrom): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_export_settings.pyi b/gooddata-api-client/gooddata_api_client/model/dashboard_export_settings.pyi new file mode 100644 index 000000000..f821c2b19 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_export_settings.pyi @@ -0,0 +1,141 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DashboardExportSettings( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Additional settings. + """ + + + class MetaOapg: + + class properties: + exportInfo = schemas.BoolSchema + mergeHeaders = schemas.BoolSchema + + + class pageOrientation( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PORTRAIT(cls): + return cls("PORTRAIT") + + @schemas.classproperty + def LANDSCAPE(cls): + return cls("LANDSCAPE") + + + class pageSize( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def A3(cls): + return cls("A3") + + @schemas.classproperty + def A4(cls): + return cls("A4") + + @schemas.classproperty + def LETTER(cls): + return cls("LETTER") + __annotations__ = { + "exportInfo": exportInfo, + "mergeHeaders": mergeHeaders, + "pageOrientation": pageOrientation, + "pageSize": pageSize, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["exportInfo"]) -> MetaOapg.properties.exportInfo: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["mergeHeaders"]) -> MetaOapg.properties.mergeHeaders: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["pageOrientation"]) -> MetaOapg.properties.pageOrientation: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["pageSize"]) -> MetaOapg.properties.pageSize: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["exportInfo", "mergeHeaders", "pageOrientation", "pageSize", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["exportInfo"]) -> typing.Union[MetaOapg.properties.exportInfo, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["mergeHeaders"]) -> typing.Union[MetaOapg.properties.mergeHeaders, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["pageOrientation"]) -> typing.Union[MetaOapg.properties.pageOrientation, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["pageSize"]) -> typing.Union[MetaOapg.properties.pageSize, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["exportInfo", "mergeHeaders", "pageOrientation", "pageSize", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + exportInfo: typing.Union[MetaOapg.properties.exportInfo, bool, schemas.Unset] = schemas.unset, + mergeHeaders: typing.Union[MetaOapg.properties.mergeHeaders, bool, schemas.Unset] = schemas.unset, + pageOrientation: typing.Union[MetaOapg.properties.pageOrientation, str, schemas.Unset] = schemas.unset, + pageSize: typing.Union[MetaOapg.properties.pageSize, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DashboardExportSettings': + return super().__new__( + cls, + *_args, + exportInfo=exportInfo, + mergeHeaders=mergeHeaders, + pageOrientation=pageOrientation, + pageSize=pageSize, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_filter.pyi b/gooddata-api-client/gooddata_api_client/model/dashboard_filter.pyi new file mode 100644 index 000000000..5df9e89c9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_filter.pyi @@ -0,0 +1,70 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DashboardFilter( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + DashboardAttributeFilter, + DashboardDateFilter, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DashboardFilter': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.dashboard_attribute_filter import DashboardAttributeFilter +from gooddata_api_client.model.dashboard_date_filter import DashboardDateFilter diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_permissions_assignment.pyi b/gooddata-api-client/gooddata_api_client/model/dashboard_permissions_assignment.pyi new file mode 100644 index 000000000..5c1fc2ff0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_permissions_assignment.pyi @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DashboardPermissionsAssignment( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Desired levels of permissions for an assignee. + """ + + + class MetaOapg: + required = { + "permissions", + } + + class properties: + + + class permissions( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def EDIT(cls): + return cls("EDIT") + + @schemas.classproperty + def SHARE(cls): + return cls("SHARE") + + @schemas.classproperty + def VIEW(cls): + return cls("VIEW") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'permissions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "permissions": permissions, + } + + permissions: MetaOapg.properties.permissions + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["permissions", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["permissions", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + permissions: typing.Union[MetaOapg.properties.permissions, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DashboardPermissionsAssignment': + return super().__new__( + cls, + *_args, + permissions=permissions, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_slides_template.pyi b/gooddata-api-client/gooddata_api_client/model/dashboard_slides_template.pyi new file mode 100644 index 000000000..51f8acb46 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_slides_template.pyi @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DashboardSlidesTemplate( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Template for dashboard slides export. +Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + """ + + + class MetaOapg: + required = { + "appliedOn", + } + + class properties: + + + class appliedOn( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PDF(cls): + return cls("PDF") + + @schemas.classproperty + def PPTX(cls): + return cls("PPTX") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'appliedOn': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def contentSlide() -> typing.Type['ContentSlideTemplate']: + return ContentSlideTemplate + + @staticmethod + def coverSlide() -> typing.Type['CoverSlideTemplate']: + return CoverSlideTemplate + + @staticmethod + def introSlide() -> typing.Type['IntroSlideTemplate']: + return IntroSlideTemplate + + @staticmethod + def sectionSlide() -> typing.Type['SectionSlideTemplate']: + return SectionSlideTemplate + __annotations__ = { + "appliedOn": appliedOn, + "contentSlide": contentSlide, + "coverSlide": coverSlide, + "introSlide": introSlide, + "sectionSlide": sectionSlide, + } + + + appliedOn: MetaOapg.properties.appliedOn + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["contentSlide"]) -> 'ContentSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["coverSlide"]) -> 'CoverSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["introSlide"]) -> 'IntroSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sectionSlide"]) -> 'SectionSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", "coverSlide", "introSlide", "sectionSlide", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["contentSlide"]) -> typing.Union['ContentSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["coverSlide"]) -> typing.Union['CoverSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["introSlide"]) -> typing.Union['IntroSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sectionSlide"]) -> typing.Union['SectionSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", "coverSlide", "introSlide", "sectionSlide", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + contentSlide: typing.Union['ContentSlideTemplate', schemas.Unset] = schemas.unset, + coverSlide: typing.Union['CoverSlideTemplate', schemas.Unset] = schemas.unset, + introSlide: typing.Union['IntroSlideTemplate', schemas.Unset] = schemas.unset, + sectionSlide: typing.Union['SectionSlideTemplate', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DashboardSlidesTemplate': + return super().__new__( + cls, + *_args, + contentSlide=contentSlide, + coverSlide=coverSlide, + introSlide=introSlide, + sectionSlide=sectionSlide, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.content_slide_template import ContentSlideTemplate +from gooddata_api_client.model.cover_slide_template import CoverSlideTemplate +from gooddata_api_client.model.intro_slide_template import IntroSlideTemplate +from gooddata_api_client.model.section_slide_template import SectionSlideTemplate diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request.pyi b/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request.pyi new file mode 100644 index 000000000..5bdb98b38 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request.pyi @@ -0,0 +1,257 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DashboardTabularExportRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Export request object describing the export properties for dashboard tabular exports. + """ + + + class MetaOapg: + required = { + "fileName", + "format", + } + + class properties: + fileName = schemas.StrSchema + + + class format( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def XLSX(cls): + return cls("XLSX") + + @schemas.classproperty + def PDF(cls): + return cls("PDF") + + + class dashboardFiltersOverride( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DashboardFilter']: + return DashboardFilter + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DashboardFilter'], typing.List['DashboardFilter']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dashboardFiltersOverride': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DashboardFilter': + return super().__getitem__(i) + + + class dashboardTabsFiltersOverrides( + schemas.DictSchema + ): + + + class MetaOapg: + + + class additional_properties( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DashboardFilter']: + return DashboardFilter + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DashboardFilter'], typing.List['DashboardFilter']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'additional_properties': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DashboardFilter': + return super().__getitem__(i) + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, list, tuple, ], + ) -> 'dashboardTabsFiltersOverrides': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @staticmethod + def settings() -> typing.Type['DashboardExportSettings']: + return DashboardExportSettings + + + class widgetIds( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'widgetIds': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "fileName": fileName, + "format": format, + "dashboardFiltersOverride": dashboardFiltersOverride, + "dashboardTabsFiltersOverrides": dashboardTabsFiltersOverrides, + "settings": settings, + "widgetIds": widgetIds, + } + + fileName: MetaOapg.properties.fileName + format: MetaOapg.properties.format + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardFiltersOverride"]) -> MetaOapg.properties.dashboardFiltersOverride: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardTabsFiltersOverrides"]) -> MetaOapg.properties.dashboardTabsFiltersOverrides: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["settings"]) -> 'DashboardExportSettings': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetIds"]) -> MetaOapg.properties.widgetIds: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["fileName", "format", "dashboardFiltersOverride", "dashboardTabsFiltersOverrides", "settings", "widgetIds", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardFiltersOverride"]) -> typing.Union[MetaOapg.properties.dashboardFiltersOverride, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardTabsFiltersOverrides"]) -> typing.Union[MetaOapg.properties.dashboardTabsFiltersOverrides, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["settings"]) -> typing.Union['DashboardExportSettings', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetIds"]) -> typing.Union[MetaOapg.properties.widgetIds, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["fileName", "format", "dashboardFiltersOverride", "dashboardTabsFiltersOverrides", "settings", "widgetIds", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + fileName: typing.Union[MetaOapg.properties.fileName, str, ], + format: typing.Union[MetaOapg.properties.format, str, ], + dashboardFiltersOverride: typing.Union[MetaOapg.properties.dashboardFiltersOverride, list, tuple, schemas.Unset] = schemas.unset, + dashboardTabsFiltersOverrides: typing.Union[MetaOapg.properties.dashboardTabsFiltersOverrides, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + settings: typing.Union['DashboardExportSettings', schemas.Unset] = schemas.unset, + widgetIds: typing.Union[MetaOapg.properties.widgetIds, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DashboardTabularExportRequest': + return super().__new__( + cls, + *_args, + fileName=fileName, + format=format, + dashboardFiltersOverride=dashboardFiltersOverride, + dashboardTabsFiltersOverrides=dashboardTabsFiltersOverrides, + settings=settings, + widgetIds=widgetIds, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.dashboard_export_settings import DashboardExportSettings +from gooddata_api_client.model.dashboard_filter import DashboardFilter diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request_v2.pyi b/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request_v2.pyi new file mode 100644 index 000000000..ee89f04c1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request_v2.pyi @@ -0,0 +1,269 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DashboardTabularExportRequestV2( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId). + """ + + + class MetaOapg: + required = { + "fileName", + "dashboardId", + "format", + } + + class properties: + dashboardId = schemas.StrSchema + fileName = schemas.StrSchema + + + class format( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def XLSX(cls): + return cls("XLSX") + + @schemas.classproperty + def PDF(cls): + return cls("PDF") + + + class dashboardFiltersOverride( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DashboardFilter']: + return DashboardFilter + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DashboardFilter'], typing.List['DashboardFilter']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dashboardFiltersOverride': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DashboardFilter': + return super().__getitem__(i) + + + class dashboardTabsFiltersOverrides( + schemas.DictSchema + ): + + + class MetaOapg: + + + class additional_properties( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DashboardFilter']: + return DashboardFilter + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DashboardFilter'], typing.List['DashboardFilter']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'additional_properties': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DashboardFilter': + return super().__getitem__(i) + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, list, tuple, ], + ) -> 'dashboardTabsFiltersOverrides': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @staticmethod + def settings() -> typing.Type['DashboardExportSettings']: + return DashboardExportSettings + + + class widgetIds( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'widgetIds': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "dashboardId": dashboardId, + "fileName": fileName, + "format": format, + "dashboardFiltersOverride": dashboardFiltersOverride, + "dashboardTabsFiltersOverrides": dashboardTabsFiltersOverrides, + "settings": settings, + "widgetIds": widgetIds, + } + + fileName: MetaOapg.properties.fileName + dashboardId: MetaOapg.properties.dashboardId + format: MetaOapg.properties.format + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardId"]) -> MetaOapg.properties.dashboardId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardFiltersOverride"]) -> MetaOapg.properties.dashboardFiltersOverride: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardTabsFiltersOverrides"]) -> MetaOapg.properties.dashboardTabsFiltersOverrides: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["settings"]) -> 'DashboardExportSettings': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetIds"]) -> MetaOapg.properties.widgetIds: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dashboardId", "fileName", "format", "dashboardFiltersOverride", "dashboardTabsFiltersOverrides", "settings", "widgetIds", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardId"]) -> MetaOapg.properties.dashboardId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardFiltersOverride"]) -> typing.Union[MetaOapg.properties.dashboardFiltersOverride, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardTabsFiltersOverrides"]) -> typing.Union[MetaOapg.properties.dashboardTabsFiltersOverrides, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["settings"]) -> typing.Union['DashboardExportSettings', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetIds"]) -> typing.Union[MetaOapg.properties.widgetIds, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dashboardId", "fileName", "format", "dashboardFiltersOverride", "dashboardTabsFiltersOverrides", "settings", "widgetIds", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + fileName: typing.Union[MetaOapg.properties.fileName, str, ], + dashboardId: typing.Union[MetaOapg.properties.dashboardId, str, ], + format: typing.Union[MetaOapg.properties.format, str, ], + dashboardFiltersOverride: typing.Union[MetaOapg.properties.dashboardFiltersOverride, list, tuple, schemas.Unset] = schemas.unset, + dashboardTabsFiltersOverrides: typing.Union[MetaOapg.properties.dashboardTabsFiltersOverrides, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + settings: typing.Union['DashboardExportSettings', schemas.Unset] = schemas.unset, + widgetIds: typing.Union[MetaOapg.properties.widgetIds, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DashboardTabularExportRequestV2': + return super().__new__( + cls, + *_args, + fileName=fileName, + dashboardId=dashboardId, + format=format, + dashboardFiltersOverride=dashboardFiltersOverride, + dashboardTabsFiltersOverrides=dashboardTabsFiltersOverrides, + settings=settings, + widgetIds=widgetIds, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.dashboard_export_settings import DashboardExportSettings +from gooddata_api_client.model.dashboard_filter import DashboardFilter diff --git a/gooddata-api-client/gooddata_api_client/model/data_source_permission_assignment.pyi b/gooddata-api-client/gooddata_api_client/model/data_source_permission_assignment.pyi new file mode 100644 index 000000000..1d8ca436a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/data_source_permission_assignment.pyi @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DataSourcePermissionAssignment( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Data source permission assignments + """ + + + class MetaOapg: + required = { + "assigneeIdentifier", + "permissions", + } + + class properties: + + @staticmethod + def assigneeIdentifier() -> typing.Type['AssigneeIdentifier']: + return AssigneeIdentifier + + + class permissions( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MANAGE(cls): + return cls("MANAGE") + + @schemas.classproperty + def USE(cls): + return cls("USE") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'permissions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "assigneeIdentifier": assigneeIdentifier, + "permissions": permissions, + } + + assigneeIdentifier: 'AssigneeIdentifier' + permissions: MetaOapg.properties.permissions + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["assigneeIdentifier"]) -> 'AssigneeIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["assigneeIdentifier", "permissions", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["assigneeIdentifier"]) -> 'AssigneeIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["assigneeIdentifier", "permissions", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + assigneeIdentifier: 'AssigneeIdentifier', + permissions: typing.Union[MetaOapg.properties.permissions, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DataSourcePermissionAssignment': + return super().__new__( + cls, + *_args, + assigneeIdentifier=assigneeIdentifier, + permissions=permissions, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/database_instance.pyi b/gooddata-api-client/gooddata_api_client/model/database_instance.pyi new file mode 100644 index 000000000..a020d6768 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/database_instance.pyi @@ -0,0 +1,132 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DatabaseInstance( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A single AI Lake Database instance + """ + + + class MetaOapg: + required = { + "storageIds", + "name", + "id", + } + + class properties: + id = schemas.StrSchema + name = schemas.StrSchema + + + class storageIds( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'storageIds': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "id": id, + "name": name, + "storageIds": storageIds, + } + + storageIds: MetaOapg.properties.storageIds + name: MetaOapg.properties.name + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["storageIds"]) -> MetaOapg.properties.storageIds: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "name", "storageIds", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["storageIds"]) -> MetaOapg.properties.storageIds: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "name", "storageIds", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + storageIds: typing.Union[MetaOapg.properties.storageIds, list, tuple, ], + name: typing.Union[MetaOapg.properties.name, str, ], + id: typing.Union[MetaOapg.properties.id, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DatabaseInstance': + return super().__new__( + cls, + *_args, + storageIds=storageIds, + name=name, + id=id, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/dataset_grain.pyi b/gooddata-api-client/gooddata_api_client/model/dataset_grain.pyi new file mode 100644 index 000000000..079d028d5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/dataset_grain.pyi @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DatasetGrain( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ATTRIBUTE(cls): + return cls("attribute") + + @schemas.classproperty + def DATE(cls): + return cls("date") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DatasetGrain': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/dataset_workspace_data_filter_identifier.pyi b/gooddata-api-client/gooddata_api_client/model/dataset_workspace_data_filter_identifier.pyi new file mode 100644 index 000000000..352352293 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/dataset_workspace_data_filter_identifier.pyi @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DatasetWorkspaceDataFilterIdentifier( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Identifier of a workspace data filter. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def WORKSPACE_DATA_FILTER(cls): + return cls("workspaceDataFilter") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DatasetWorkspaceDataFilterIdentifier': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/date_absolute_filter.pyi b/gooddata-api-client/gooddata_api_client/model/date_absolute_filter.pyi new file mode 100644 index 000000000..e19eca919 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/date_absolute_filter.pyi @@ -0,0 +1,145 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DateAbsoluteFilter( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "using", + "from", + "to", + } + + + class all_of_1( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + _from = schemas.StrSchema + to = schemas.StrSchema + using = schemas.StrSchema + __annotations__ = { + "from": _from, + "to": to, + "using": using, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> MetaOapg.properties.to: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["using"]) -> MetaOapg.properties.using: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["from", "to", "using", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> typing.Union[MetaOapg.properties._from, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> typing.Union[MetaOapg.properties.to, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["using"]) -> typing.Union[MetaOapg.properties.using, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["from", "to", "using", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + to: typing.Union[MetaOapg.properties.to, str, schemas.Unset] = schemas.unset, + using: typing.Union[MetaOapg.properties.using, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + to=to, + using=using, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + Filter, + cls.all_of_1, + ] + + + using: schemas.AnyTypeSchema + to: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DateAbsoluteFilter': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.filter import Filter diff --git a/gooddata-api-client/gooddata_api_client/model/date_filter.py b/gooddata-api-client/gooddata_api_client/model/date_filter.py index 08ea26a7c..b08077872 100644 --- a/gooddata-api-client/gooddata_api_client/model/date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/date_filter.py @@ -31,16 +31,16 @@ def lazy_import(): - 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.absolute_date_filter import AbsoluteDateFilter from gooddata_api_client.model.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter + from gooddata_api_client.model.all_time_date_filter import AllTimeDateFilter + from gooddata_api_client.model.all_time_date_filter_all_time_date_filter import AllTimeDateFilterAllTimeDateFilter from gooddata_api_client.model.relative_date_filter import RelativeDateFilter from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter - globals()['AllTimeDateFilter'] = AllTimeDateFilter - globals()['AllTimeDateFilterAllTimeDateFilter'] = AllTimeDateFilterAllTimeDateFilter globals()['AbsoluteDateFilter'] = AbsoluteDateFilter globals()['AbsoluteDateFilterAbsoluteDateFilter'] = AbsoluteDateFilterAbsoluteDateFilter + globals()['AllTimeDateFilter'] = AllTimeDateFilter + globals()['AllTimeDateFilterAllTimeDateFilter'] = AllTimeDateFilterAllTimeDateFilter globals()['RelativeDateFilter'] = RelativeDateFilter globals()['RelativeDateFilterRelativeDateFilter'] = RelativeDateFilterRelativeDateFilter @@ -98,9 +98,9 @@ def openapi_types(): """ lazy_import() return { - 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 + 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 } @cached_property @@ -109,9 +109,9 @@ def discriminator(): attribute_map = { - 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 'relative_date_filter': 'relativeDateFilter', # noqa: E501 + 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 } read_only_vars = { @@ -155,6 +155,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 + all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -260,6 +261,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 + all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -331,8 +333,8 @@ def _composed_schemas(): 'allOf': [ ], 'oneOf': [ - AllTimeDateFilter, AbsoluteDateFilter, + AllTimeDateFilter, RelativeDateFilter, ], } diff --git a/gooddata-api-client/gooddata_api_client/model/date_relative_filter.pyi b/gooddata-api-client/gooddata_api_client/model/date_relative_filter.pyi new file mode 100644 index 000000000..a2fbbfd00 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/date_relative_filter.pyi @@ -0,0 +1,238 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DateRelativeFilter( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "using", + "granularity", + "from", + "to", + } + + + class all_of_1( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + _from = schemas.Int32Schema + + + class granularity( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MINUTE(cls): + return cls("MINUTE") + + @schemas.classproperty + def HOUR(cls): + return cls("HOUR") + + @schemas.classproperty + def DAY(cls): + return cls("DAY") + + @schemas.classproperty + def WEEK(cls): + return cls("WEEK") + + @schemas.classproperty + def MONTH(cls): + return cls("MONTH") + + @schemas.classproperty + def QUARTER(cls): + return cls("QUARTER") + + @schemas.classproperty + def YEAR(cls): + return cls("YEAR") + + @schemas.classproperty + def MINUTE_OF_HOUR(cls): + return cls("MINUTE_OF_HOUR") + + @schemas.classproperty + def HOUR_OF_DAY(cls): + return cls("HOUR_OF_DAY") + + @schemas.classproperty + def DAY_OF_WEEK(cls): + return cls("DAY_OF_WEEK") + + @schemas.classproperty + def DAY_OF_MONTH(cls): + return cls("DAY_OF_MONTH") + + @schemas.classproperty + def DAY_OF_QUARTER(cls): + return cls("DAY_OF_QUARTER") + + @schemas.classproperty + def DAY_OF_YEAR(cls): + return cls("DAY_OF_YEAR") + + @schemas.classproperty + def WEEK_OF_YEAR(cls): + return cls("WEEK_OF_YEAR") + + @schemas.classproperty + def MONTH_OF_YEAR(cls): + return cls("MONTH_OF_YEAR") + + @schemas.classproperty + def QUARTER_OF_YEAR(cls): + return cls("QUARTER_OF_YEAR") + + @schemas.classproperty + def FISCAL_MONTH(cls): + return cls("FISCAL_MONTH") + + @schemas.classproperty + def FISCAL_QUARTER(cls): + return cls("FISCAL_QUARTER") + + @schemas.classproperty + def FISCAL_YEAR(cls): + return cls("FISCAL_YEAR") + to = schemas.Int32Schema + using = schemas.StrSchema + __annotations__ = { + "from": _from, + "granularity": granularity, + "to": to, + "using": using, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> MetaOapg.properties.to: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["using"]) -> MetaOapg.properties.using: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["from", "granularity", "to", "using", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> typing.Union[MetaOapg.properties._from, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["granularity"]) -> typing.Union[MetaOapg.properties.granularity, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> typing.Union[MetaOapg.properties.to, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["using"]) -> typing.Union[MetaOapg.properties.using, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["from", "granularity", "to", "using", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + granularity: typing.Union[MetaOapg.properties.granularity, str, schemas.Unset] = schemas.unset, + to: typing.Union[MetaOapg.properties.to, decimal.Decimal, int, schemas.Unset] = schemas.unset, + using: typing.Union[MetaOapg.properties.using, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + granularity=granularity, + to=to, + using=using, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + Filter, + cls.all_of_1, + ] + + + using: schemas.AnyTypeSchema + granularity: schemas.AnyTypeSchema + to: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DateRelativeFilter': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.filter import Filter diff --git a/gooddata-api-client/gooddata_api_client/model/date_value.pyi b/gooddata-api-client/gooddata_api_client/model/date_value.pyi new file mode 100644 index 000000000..65b230d9f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/date_value.pyi @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DateValue( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "value", + } + + class properties: + value = schemas.StrSchema + __annotations__ = { + "value": value, + } + + value: MetaOapg.properties.value + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["value", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["value", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + value: typing.Union[MetaOapg.properties.value, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DateValue': + return super().__new__( + cls, + *_args, + value=value, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_aggregated_fact.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_aggregated_fact.pyi new file mode 100644 index 000000000..9f72e3959 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_aggregated_fact.pyi @@ -0,0 +1,235 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeAggregatedFact( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A dataset fact. + """ + + + class MetaOapg: + required = { + "sourceFactReference", + "id", + "sourceColumn", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class sourceColumn( + schemas.StrSchema + ): + pass + + @staticmethod + def sourceFactReference() -> typing.Type['DeclarativeSourceFactReference']: + return DeclarativeSourceFactReference + + + class description( + schemas.StrSchema + ): + pass + isNullable = schemas.BoolSchema + nullValue = schemas.StrSchema + + + class sourceColumnDataType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INT(cls): + return cls("INT") + + @schemas.classproperty + def STRING(cls): + return cls("STRING") + + @schemas.classproperty + def DATE(cls): + return cls("DATE") + + @schemas.classproperty + def NUMERIC(cls): + return cls("NUMERIC") + + @schemas.classproperty + def TIMESTAMP(cls): + return cls("TIMESTAMP") + + @schemas.classproperty + def TIMESTAMP_TZ(cls): + return cls("TIMESTAMP_TZ") + + @schemas.classproperty + def BOOLEAN(cls): + return cls("BOOLEAN") + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "id": id, + "sourceColumn": sourceColumn, + "sourceFactReference": sourceFactReference, + "description": description, + "isNullable": isNullable, + "nullValue": nullValue, + "sourceColumnDataType": sourceColumnDataType, + "tags": tags, + } + + sourceFactReference: 'DeclarativeSourceFactReference' + id: MetaOapg.properties.id + sourceColumn: MetaOapg.properties.sourceColumn + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sourceColumn"]) -> MetaOapg.properties.sourceColumn: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sourceFactReference"]) -> 'DeclarativeSourceFactReference': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isNullable"]) -> MetaOapg.properties.isNullable: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["nullValue"]) -> MetaOapg.properties.nullValue: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sourceColumnDataType"]) -> MetaOapg.properties.sourceColumnDataType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "sourceColumn", "sourceFactReference", "description", "isNullable", "nullValue", "sourceColumnDataType", "tags", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sourceColumn"]) -> MetaOapg.properties.sourceColumn: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sourceFactReference"]) -> 'DeclarativeSourceFactReference': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isNullable"]) -> typing.Union[MetaOapg.properties.isNullable, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["nullValue"]) -> typing.Union[MetaOapg.properties.nullValue, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sourceColumnDataType"]) -> typing.Union[MetaOapg.properties.sourceColumnDataType, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "sourceColumn", "sourceFactReference", "description", "isNullable", "nullValue", "sourceColumnDataType", "tags", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + sourceFactReference: 'DeclarativeSourceFactReference', + id: typing.Union[MetaOapg.properties.id, str, ], + sourceColumn: typing.Union[MetaOapg.properties.sourceColumn, str, ], + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + isNullable: typing.Union[MetaOapg.properties.isNullable, bool, schemas.Unset] = schemas.unset, + nullValue: typing.Union[MetaOapg.properties.nullValue, str, schemas.Unset] = schemas.unset, + sourceColumnDataType: typing.Union[MetaOapg.properties.sourceColumnDataType, str, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeAggregatedFact': + return super().__new__( + cls, + *_args, + sourceFactReference=sourceFactReference, + id=id, + sourceColumn=sourceColumn, + description=description, + isNullable=isNullable, + nullValue=nullValue, + sourceColumnDataType=sourceColumnDataType, + tags=tags, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.declarative_source_fact_reference import DeclarativeSourceFactReference diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard.py b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard.py index cfe1618fd..448bf1bc4 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard.py @@ -64,6 +64,9 @@ class DeclarativeAnalyticalDashboard(ModelNormal): """ allowed_values = { + ('certification',): { + 'CERTIFIED': "CERTIFIED", + }, } validations = { @@ -75,6 +78,11 @@ class DeclarativeAnalyticalDashboard(ModelNormal): ('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 @@ -121,6 +129,10 @@ def openapi_types(): 'content': (JsonNode,), # noqa: E501 'id': (str,), # noqa: E501 'title': (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 'description': (str,), # noqa: E501 @@ -140,6 +152,10 @@ def discriminator(): 'content': 'content', # noqa: E501 'id': 'id', # noqa: E501 'title': 'title', # 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 'description': 'description', # noqa: E501 @@ -196,6 +212,10 @@ def _from_openapi_data(cls, content, 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,) + 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 description (str): Analytical dashboard description.. [optional] # noqa: E501 @@ -297,6 +317,10 @@ def __init__(self, content, 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,) + 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 description (str): Analytical dashboard description.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_identifier.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_identifier.pyi new file mode 100644 index 000000000..8d8c7f002 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_identifier.pyi @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeAnalyticalDashboardIdentifier( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + An analytical dashboard identifier. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeAnalyticalDashboardIdentifier': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_assignment.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_assignment.pyi new file mode 100644 index 000000000..4a9c78a9e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_assignment.pyi @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeAnalyticalDashboardPermissionAssignment( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Analytical dashboard permission. + """ + + + class MetaOapg: + required = { + "name", + } + + class properties: + + + class name( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def EDIT(cls): + return cls("EDIT") + + @schemas.classproperty + def SHARE(cls): + return cls("SHARE") + + @schemas.classproperty + def VIEW(cls): + return cls("VIEW") + __annotations__ = { + "name": name, + } + + name: MetaOapg.properties.name + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["name", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["name", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + name: typing.Union[MetaOapg.properties.name, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeAnalyticalDashboardPermissionAssignment': + return super().__new__( + cls, + *_args, + name=name, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee.pyi new file mode 100644 index 000000000..d3e657641 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee.pyi @@ -0,0 +1,132 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeAnalyticalDashboardPermissionForAssignee( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Analytical dashboard permission for an assignee. + """ + + + class MetaOapg: + required = { + "name", + "assignee", + } + + + class all_of_1( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def assignee() -> typing.Type['AssigneeIdentifier']: + return AssigneeIdentifier + __annotations__ = { + "assignee": assignee, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["assignee"]) -> 'AssigneeIdentifier': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["assignee", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["assignee"]) -> typing.Union['AssigneeIdentifier', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["assignee", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + assignee: typing.Union['AssigneeIdentifier', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + assignee=assignee, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + DeclarativeAnalyticalDashboardPermissionAssignment, + cls.all_of_1, + ] + + + name: schemas.AnyTypeSchema + assignee: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeAnalyticalDashboardPermissionForAssignee': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.model.declarative_analytical_dashboard_permission_assignment import DeclarativeAnalyticalDashboardPermissionAssignment diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee_rule.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee_rule.pyi new file mode 100644 index 000000000..491dd2bd3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee_rule.pyi @@ -0,0 +1,132 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeAnalyticalDashboardPermissionForAssigneeRule( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Analytical dashboard permission for a collection of assignees identified by a rule. + """ + + + class MetaOapg: + required = { + "name", + "assigneeRule", + } + + + class all_of_1( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def assigneeRule() -> typing.Type['AssigneeRule']: + return AssigneeRule + __annotations__ = { + "assigneeRule": assigneeRule, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["assigneeRule"]) -> 'AssigneeRule': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["assigneeRule", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["assigneeRule"]) -> typing.Union['AssigneeRule', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["assigneeRule", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + assigneeRule: typing.Union['AssigneeRule', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + assigneeRule=assigneeRule, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + DeclarativeAnalyticalDashboardPermissionAssignment, + cls.all_of_1, + ] + + + name: schemas.AnyTypeSchema + assigneeRule: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeAnalyticalDashboardPermissionForAssigneeRule': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.assignee_rule import AssigneeRule +from gooddata_api_client.model.declarative_analytical_dashboard_permission_assignment import DeclarativeAnalyticalDashboardPermissionAssignment diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_attribute_hierarchy.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_attribute_hierarchy.pyi new file mode 100644 index 000000000..9e9aa0b80 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_attribute_hierarchy.pyi @@ -0,0 +1,261 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeAttributeHierarchy( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "id", + "title", + "content", + } + + class properties: + + @staticmethod + def content() -> typing.Type['JsonNode']: + return JsonNode + + + class id( + schemas.StrSchema + ): + pass + + + class title( + schemas.StrSchema + ): + pass + + + class createdAt( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'createdAt': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + @staticmethod + def createdBy() -> typing.Type['DeclarativeUserIdentifier']: + return DeclarativeUserIdentifier + + + class description( + schemas.StrSchema + ): + pass + + + class modifiedAt( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'modifiedAt': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + @staticmethod + def modifiedBy() -> typing.Type['DeclarativeUserIdentifier']: + return DeclarativeUserIdentifier + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "content": content, + "id": id, + "title": title, + "createdAt": createdAt, + "createdBy": createdBy, + "description": description, + "modifiedAt": modifiedAt, + "modifiedBy": modifiedBy, + "tags": tags, + } + + id: MetaOapg.properties.id + title: MetaOapg.properties.title + content: 'JsonNode' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdAt"]) -> MetaOapg.properties.createdAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdBy"]) -> 'DeclarativeUserIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedAt"]) -> MetaOapg.properties.modifiedAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedBy"]) -> 'DeclarativeUserIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["content", "id", "title", "createdAt", "createdBy", "description", "modifiedAt", "modifiedBy", "tags", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> 'JsonNode': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdAt"]) -> typing.Union[MetaOapg.properties.createdAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdBy"]) -> typing.Union['DeclarativeUserIdentifier', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedAt"]) -> typing.Union[MetaOapg.properties.modifiedAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedBy"]) -> typing.Union['DeclarativeUserIdentifier', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["content", "id", "title", "createdAt", "createdBy", "description", "modifiedAt", "modifiedBy", "tags", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + title: typing.Union[MetaOapg.properties.title, str, ], + content: 'JsonNode', + createdAt: typing.Union[MetaOapg.properties.createdAt, None, str, schemas.Unset] = schemas.unset, + createdBy: typing.Union['DeclarativeUserIdentifier', schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + modifiedAt: typing.Union[MetaOapg.properties.modifiedAt, None, str, schemas.Unset] = schemas.unset, + modifiedBy: typing.Union['DeclarativeUserIdentifier', schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeAttributeHierarchy': + return super().__new__( + cls, + *_args, + id=id, + title=title, + content=content, + createdAt=createdAt, + createdBy=createdBy, + description=description, + modifiedAt=modifiedAt, + modifiedBy=modifiedBy, + tags=tags, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_automation.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_automation.pyi new file mode 100644 index 000000000..be0f75e4e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_automation.pyi @@ -0,0 +1,725 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeAutomation( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "id", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + @staticmethod + def alert() -> typing.Type['AutomationAlert']: + return AutomationAlert + + @staticmethod + def analyticalDashboard() -> typing.Type['DeclarativeAnalyticalDashboardIdentifier']: + return DeclarativeAnalyticalDashboardIdentifier + + + class createdAt( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'createdAt': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + @staticmethod + def createdBy() -> typing.Type['DeclarativeUserIdentifier']: + return DeclarativeUserIdentifier + + + class dashboardTabularExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AutomationDashboardTabularExport']: + return AutomationDashboardTabularExport + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AutomationDashboardTabularExport'], typing.List['AutomationDashboardTabularExport']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dashboardTabularExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AutomationDashboardTabularExport': + return super().__getitem__(i) + + + class description( + schemas.StrSchema + ): + pass + + + class details( + schemas.DictSchema + ): + + + class MetaOapg: + + + class additional_properties( + schemas.StrSchema + ): + pass + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, str, ], + ) -> 'details': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class evaluationMode( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SHARED(cls): + return cls("SHARED") + + @schemas.classproperty + def PER_RECIPIENT(cls): + return cls("PER_RECIPIENT") + + + class exportDefinitions( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeExportDefinitionIdentifier']: + return DeclarativeExportDefinitionIdentifier + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeExportDefinitionIdentifier'], typing.List['DeclarativeExportDefinitionIdentifier']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'exportDefinitions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeExportDefinitionIdentifier': + return super().__getitem__(i) + + + class externalRecipients( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AutomationExternalRecipient']: + return AutomationExternalRecipient + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AutomationExternalRecipient'], typing.List['AutomationExternalRecipient']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'externalRecipients': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AutomationExternalRecipient': + return super().__getitem__(i) + + + class imageExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AutomationImageExport']: + return AutomationImageExport + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AutomationImageExport'], typing.List['AutomationImageExport']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'imageExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AutomationImageExport': + return super().__getitem__(i) + + @staticmethod + def metadata() -> typing.Type['AutomationMetadata']: + return AutomationMetadata + + + class modifiedAt( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'modifiedAt': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + @staticmethod + def modifiedBy() -> typing.Type['DeclarativeUserIdentifier']: + return DeclarativeUserIdentifier + + @staticmethod + def notificationChannel() -> typing.Type['DeclarativeNotificationChannelIdentifier']: + return DeclarativeNotificationChannelIdentifier + + + class rawExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AutomationRawExport']: + return AutomationRawExport + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AutomationRawExport'], typing.List['AutomationRawExport']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'rawExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AutomationRawExport': + return super().__getitem__(i) + + + class recipients( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeUserIdentifier']: + return DeclarativeUserIdentifier + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeUserIdentifier'], typing.List['DeclarativeUserIdentifier']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'recipients': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeUserIdentifier': + return super().__getitem__(i) + + @staticmethod + def schedule() -> typing.Type['AutomationSchedule']: + return AutomationSchedule + + + class slidesExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AutomationSlidesExport']: + return AutomationSlidesExport + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AutomationSlidesExport'], typing.List['AutomationSlidesExport']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'slidesExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AutomationSlidesExport': + return super().__getitem__(i) + + + class state( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ACTIVE(cls): + return cls("ACTIVE") + + @schemas.classproperty + def PAUSED(cls): + return cls("PAUSED") + + + class tabularExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AutomationTabularExport']: + return AutomationTabularExport + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AutomationTabularExport'], typing.List['AutomationTabularExport']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tabularExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AutomationTabularExport': + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + + + class visualExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AutomationVisualExport']: + return AutomationVisualExport + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AutomationVisualExport'], typing.List['AutomationVisualExport']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visualExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AutomationVisualExport': + return super().__getitem__(i) + __annotations__ = { + "id": id, + "alert": alert, + "analyticalDashboard": analyticalDashboard, + "createdAt": createdAt, + "createdBy": createdBy, + "dashboardTabularExports": dashboardTabularExports, + "description": description, + "details": details, + "evaluationMode": evaluationMode, + "exportDefinitions": exportDefinitions, + "externalRecipients": externalRecipients, + "imageExports": imageExports, + "metadata": metadata, + "modifiedAt": modifiedAt, + "modifiedBy": modifiedBy, + "notificationChannel": notificationChannel, + "rawExports": rawExports, + "recipients": recipients, + "schedule": schedule, + "slidesExports": slidesExports, + "state": state, + "tabularExports": tabularExports, + "tags": tags, + "title": title, + "visualExports": visualExports, + } + + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["alert"]) -> 'AutomationAlert': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> 'DeclarativeAnalyticalDashboardIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdAt"]) -> MetaOapg.properties.createdAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdBy"]) -> 'DeclarativeUserIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardTabularExports"]) -> MetaOapg.properties.dashboardTabularExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["details"]) -> MetaOapg.properties.details: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["evaluationMode"]) -> MetaOapg.properties.evaluationMode: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["exportDefinitions"]) -> MetaOapg.properties.exportDefinitions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["externalRecipients"]) -> MetaOapg.properties.externalRecipients: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["imageExports"]) -> MetaOapg.properties.imageExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metadata"]) -> 'AutomationMetadata': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedAt"]) -> MetaOapg.properties.modifiedAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedBy"]) -> 'DeclarativeUserIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["notificationChannel"]) -> 'DeclarativeNotificationChannelIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rawExports"]) -> MetaOapg.properties.rawExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["recipients"]) -> MetaOapg.properties.recipients: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["schedule"]) -> 'AutomationSchedule': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["slidesExports"]) -> MetaOapg.properties.slidesExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["state"]) -> MetaOapg.properties.state: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tabularExports"]) -> MetaOapg.properties.tabularExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualExports"]) -> MetaOapg.properties.visualExports: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "alert", "analyticalDashboard", "createdAt", "createdBy", "dashboardTabularExports", "description", "details", "evaluationMode", "exportDefinitions", "externalRecipients", "imageExports", "metadata", "modifiedAt", "modifiedBy", "notificationChannel", "rawExports", "recipients", "schedule", "slidesExports", "state", "tabularExports", "tags", "title", "visualExports", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["alert"]) -> typing.Union['AutomationAlert', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union['DeclarativeAnalyticalDashboardIdentifier', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdAt"]) -> typing.Union[MetaOapg.properties.createdAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdBy"]) -> typing.Union['DeclarativeUserIdentifier', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardTabularExports"]) -> typing.Union[MetaOapg.properties.dashboardTabularExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["details"]) -> typing.Union[MetaOapg.properties.details, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["evaluationMode"]) -> typing.Union[MetaOapg.properties.evaluationMode, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["exportDefinitions"]) -> typing.Union[MetaOapg.properties.exportDefinitions, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["externalRecipients"]) -> typing.Union[MetaOapg.properties.externalRecipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["imageExports"]) -> typing.Union[MetaOapg.properties.imageExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metadata"]) -> typing.Union['AutomationMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedAt"]) -> typing.Union[MetaOapg.properties.modifiedAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedBy"]) -> typing.Union['DeclarativeUserIdentifier', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["notificationChannel"]) -> typing.Union['DeclarativeNotificationChannelIdentifier', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rawExports"]) -> typing.Union[MetaOapg.properties.rawExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["recipients"]) -> typing.Union[MetaOapg.properties.recipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["schedule"]) -> typing.Union['AutomationSchedule', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["slidesExports"]) -> typing.Union[MetaOapg.properties.slidesExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["state"]) -> typing.Union[MetaOapg.properties.state, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tabularExports"]) -> typing.Union[MetaOapg.properties.tabularExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualExports"]) -> typing.Union[MetaOapg.properties.visualExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "alert", "analyticalDashboard", "createdAt", "createdBy", "dashboardTabularExports", "description", "details", "evaluationMode", "exportDefinitions", "externalRecipients", "imageExports", "metadata", "modifiedAt", "modifiedBy", "notificationChannel", "rawExports", "recipients", "schedule", "slidesExports", "state", "tabularExports", "tags", "title", "visualExports", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + alert: typing.Union['AutomationAlert', schemas.Unset] = schemas.unset, + analyticalDashboard: typing.Union['DeclarativeAnalyticalDashboardIdentifier', schemas.Unset] = schemas.unset, + createdAt: typing.Union[MetaOapg.properties.createdAt, None, str, schemas.Unset] = schemas.unset, + createdBy: typing.Union['DeclarativeUserIdentifier', schemas.Unset] = schemas.unset, + dashboardTabularExports: typing.Union[MetaOapg.properties.dashboardTabularExports, list, tuple, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + details: typing.Union[MetaOapg.properties.details, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + evaluationMode: typing.Union[MetaOapg.properties.evaluationMode, str, schemas.Unset] = schemas.unset, + exportDefinitions: typing.Union[MetaOapg.properties.exportDefinitions, list, tuple, schemas.Unset] = schemas.unset, + externalRecipients: typing.Union[MetaOapg.properties.externalRecipients, list, tuple, schemas.Unset] = schemas.unset, + imageExports: typing.Union[MetaOapg.properties.imageExports, list, tuple, schemas.Unset] = schemas.unset, + metadata: typing.Union['AutomationMetadata', schemas.Unset] = schemas.unset, + modifiedAt: typing.Union[MetaOapg.properties.modifiedAt, None, str, schemas.Unset] = schemas.unset, + modifiedBy: typing.Union['DeclarativeUserIdentifier', schemas.Unset] = schemas.unset, + notificationChannel: typing.Union['DeclarativeNotificationChannelIdentifier', schemas.Unset] = schemas.unset, + rawExports: typing.Union[MetaOapg.properties.rawExports, list, tuple, schemas.Unset] = schemas.unset, + recipients: typing.Union[MetaOapg.properties.recipients, list, tuple, schemas.Unset] = schemas.unset, + schedule: typing.Union['AutomationSchedule', schemas.Unset] = schemas.unset, + slidesExports: typing.Union[MetaOapg.properties.slidesExports, list, tuple, schemas.Unset] = schemas.unset, + state: typing.Union[MetaOapg.properties.state, str, schemas.Unset] = schemas.unset, + tabularExports: typing.Union[MetaOapg.properties.tabularExports, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + visualExports: typing.Union[MetaOapg.properties.visualExports, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeAutomation': + return super().__new__( + cls, + *_args, + id=id, + alert=alert, + analyticalDashboard=analyticalDashboard, + createdAt=createdAt, + createdBy=createdBy, + dashboardTabularExports=dashboardTabularExports, + description=description, + details=details, + evaluationMode=evaluationMode, + exportDefinitions=exportDefinitions, + externalRecipients=externalRecipients, + imageExports=imageExports, + metadata=metadata, + modifiedAt=modifiedAt, + modifiedBy=modifiedBy, + notificationChannel=notificationChannel, + rawExports=rawExports, + recipients=recipients, + schedule=schedule, + slidesExports=slidesExports, + state=state, + tabularExports=tabularExports, + tags=tags, + title=title, + visualExports=visualExports, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.automation_alert import AutomationAlert +from gooddata_api_client.model.automation_dashboard_tabular_export import AutomationDashboardTabularExport +from gooddata_api_client.model.automation_external_recipient import AutomationExternalRecipient +from gooddata_api_client.model.automation_image_export import AutomationImageExport +from gooddata_api_client.model.automation_metadata import AutomationMetadata +from gooddata_api_client.model.automation_raw_export import AutomationRawExport +from gooddata_api_client.model.automation_schedule import AutomationSchedule +from gooddata_api_client.model.automation_slides_export import AutomationSlidesExport +from gooddata_api_client.model.automation_tabular_export import AutomationTabularExport +from gooddata_api_client.model.automation_visual_export import AutomationVisualExport +from gooddata_api_client.model.declarative_analytical_dashboard_identifier import DeclarativeAnalyticalDashboardIdentifier +from gooddata_api_client.model.declarative_export_definition_identifier import DeclarativeExportDefinitionIdentifier +from gooddata_api_client.model.declarative_notification_channel_identifier import DeclarativeNotificationChannelIdentifier +from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_custom_geo_collection.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_custom_geo_collection.pyi new file mode 100644 index 000000000..f28386e35 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_custom_geo_collection.pyi @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeCustomGeoCollection( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A declarative form of custom geo collection. + """ + + + class MetaOapg: + required = { + "id", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class description( + schemas.StrSchema + ): + pass + + + class name( + schemas.StrSchema + ): + pass + __annotations__ = { + "id": id, + "description": description, + "name": name, + } + + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "description", "name", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "description", "name", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeCustomGeoCollection': + return super().__new__( + cls, + *_args, + id=id, + description=description, + name=name, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_custom_geo_collections.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_custom_geo_collections.pyi new file mode 100644 index 000000000..dbef2a098 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_custom_geo_collections.pyi @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeCustomGeoCollections( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Custom geo collections. + """ + + + class MetaOapg: + required = { + "customGeoCollections", + } + + class properties: + + + class customGeoCollections( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeCustomGeoCollection']: + return DeclarativeCustomGeoCollection + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeCustomGeoCollection'], typing.List['DeclarativeCustomGeoCollection']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'customGeoCollections': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeCustomGeoCollection': + return super().__getitem__(i) + __annotations__ = { + "customGeoCollections": customGeoCollections, + } + + customGeoCollections: MetaOapg.properties.customGeoCollections + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["customGeoCollections"]) -> MetaOapg.properties.customGeoCollections: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["customGeoCollections", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["customGeoCollections"]) -> MetaOapg.properties.customGeoCollections: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["customGeoCollections", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + customGeoCollections: typing.Union[MetaOapg.properties.customGeoCollections, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeCustomGeoCollections': + return super().__new__( + cls, + *_args, + customGeoCollections=customGeoCollections, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.declarative_custom_geo_collection import DeclarativeCustomGeoCollection diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_data_source_permissions.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_data_source_permissions.pyi new file mode 100644 index 000000000..493f57991 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_data_source_permissions.pyi @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeDataSourcePermissions( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Data source permissions. + """ + + + class MetaOapg: + + class properties: + + + class permissions( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeDataSourcePermission']: + return DeclarativeDataSourcePermission + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeDataSourcePermission'], typing.List['DeclarativeDataSourcePermission']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'permissions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeDataSourcePermission': + return super().__getitem__(i) + __annotations__ = { + "permissions": permissions, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["permissions", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> typing.Union[MetaOapg.properties.permissions, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["permissions", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + permissions: typing.Union[MetaOapg.properties.permissions, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeDataSourcePermissions': + return super().__new__( + cls, + *_args, + permissions=permissions, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.declarative_data_source_permission import DeclarativeDataSourcePermission diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_dataset_extension.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_dataset_extension.pyi new file mode 100644 index 000000000..59824beb1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_dataset_extension.pyi @@ -0,0 +1,128 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeDatasetExtension( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A dataset extension properties. + """ + + + class MetaOapg: + required = { + "id", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class workspaceDataFilterReferences( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeWorkspaceDataFilterReferences']: + return DeclarativeWorkspaceDataFilterReferences + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeWorkspaceDataFilterReferences'], typing.List['DeclarativeWorkspaceDataFilterReferences']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'workspaceDataFilterReferences': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeWorkspaceDataFilterReferences': + return super().__getitem__(i) + __annotations__ = { + "id": id, + "workspaceDataFilterReferences": workspaceDataFilterReferences, + } + + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workspaceDataFilterReferences"]) -> MetaOapg.properties.workspaceDataFilterReferences: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "workspaceDataFilterReferences", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workspaceDataFilterReferences"]) -> typing.Union[MetaOapg.properties.workspaceDataFilterReferences, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "workspaceDataFilterReferences", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + workspaceDataFilterReferences: typing.Union[MetaOapg.properties.workspaceDataFilterReferences, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeDatasetExtension': + return super().__new__( + cls, + *_args, + id=id, + workspaceDataFilterReferences=workspaceDataFilterReferences, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.declarative_workspace_data_filter_references import DeclarativeWorkspaceDataFilterReferences diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_export_definition.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_export_definition.pyi new file mode 100644 index 000000000..35ad98c94 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_export_definition.pyi @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeExportDefinition( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "id", + "title", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class title( + schemas.StrSchema + ): + pass + + + class createdAt( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'createdAt': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + @staticmethod + def createdBy() -> typing.Type['DeclarativeUserIdentifier']: + return DeclarativeUserIdentifier + + + class description( + schemas.StrSchema + ): + pass + + + class modifiedAt( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'modifiedAt': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + @staticmethod + def modifiedBy() -> typing.Type['DeclarativeUserIdentifier']: + return DeclarativeUserIdentifier + + + class requestPayload( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + TabularExportRequest, + VisualExportRequest, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'requestPayload': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "id": id, + "title": title, + "createdAt": createdAt, + "createdBy": createdBy, + "description": description, + "modifiedAt": modifiedAt, + "modifiedBy": modifiedBy, + "requestPayload": requestPayload, + "tags": tags, + } + + id: MetaOapg.properties.id + title: MetaOapg.properties.title + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdAt"]) -> MetaOapg.properties.createdAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdBy"]) -> 'DeclarativeUserIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedAt"]) -> MetaOapg.properties.modifiedAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedBy"]) -> 'DeclarativeUserIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> MetaOapg.properties.requestPayload: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "title", "createdAt", "createdBy", "description", "modifiedAt", "modifiedBy", "requestPayload", "tags", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdAt"]) -> typing.Union[MetaOapg.properties.createdAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdBy"]) -> typing.Union['DeclarativeUserIdentifier', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedAt"]) -> typing.Union[MetaOapg.properties.modifiedAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedBy"]) -> typing.Union['DeclarativeUserIdentifier', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> typing.Union[MetaOapg.properties.requestPayload, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "title", "createdAt", "createdBy", "description", "modifiedAt", "modifiedBy", "requestPayload", "tags", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + title: typing.Union[MetaOapg.properties.title, str, ], + createdAt: typing.Union[MetaOapg.properties.createdAt, None, str, schemas.Unset] = schemas.unset, + createdBy: typing.Union['DeclarativeUserIdentifier', schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + modifiedAt: typing.Union[MetaOapg.properties.modifiedAt, None, str, schemas.Unset] = schemas.unset, + modifiedBy: typing.Union['DeclarativeUserIdentifier', schemas.Unset] = schemas.unset, + requestPayload: typing.Union[MetaOapg.properties.requestPayload, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeExportDefinition': + return super().__new__( + cls, + *_args, + id=id, + title=title, + createdAt=createdAt, + createdBy=createdBy, + description=description, + modifiedAt=modifiedAt, + modifiedBy=modifiedBy, + requestPayload=requestPayload, + tags=tags, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier +from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.model.visual_export_request import VisualExportRequest diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_export_definition_identifier.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_export_definition_identifier.pyi new file mode 100644 index 000000000..baf6ef5ef --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_export_definition_identifier.pyi @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeExportDefinitionIdentifier( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + An export definition identifier. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def EXPORT_DEFINITION(cls): + return cls("exportDefinition") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeExportDefinitionIdentifier': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_export_template.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_export_template.pyi new file mode 100644 index 000000000..e94d44552 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_export_template.pyi @@ -0,0 +1,137 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeExportTemplate( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A declarative form of a particular export template. + """ + + + class MetaOapg: + required = { + "name", + "id", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class name( + schemas.StrSchema + ): + pass + + @staticmethod + def dashboardSlidesTemplate() -> typing.Type['DashboardSlidesTemplate']: + return DashboardSlidesTemplate + + @staticmethod + def widgetSlidesTemplate() -> typing.Type['WidgetSlidesTemplate']: + return WidgetSlidesTemplate + __annotations__ = { + "id": id, + "name": name, + "dashboardSlidesTemplate": dashboardSlidesTemplate, + "widgetSlidesTemplate": widgetSlidesTemplate, + } + + name: MetaOapg.properties.name + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardSlidesTemplate"]) -> 'DashboardSlidesTemplate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetSlidesTemplate"]) -> 'WidgetSlidesTemplate': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "name", "dashboardSlidesTemplate", "widgetSlidesTemplate", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardSlidesTemplate"]) -> typing.Union['DashboardSlidesTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetSlidesTemplate"]) -> typing.Union['WidgetSlidesTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "name", "dashboardSlidesTemplate", "widgetSlidesTemplate", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + name: typing.Union[MetaOapg.properties.name, str, ], + id: typing.Union[MetaOapg.properties.id, str, ], + dashboardSlidesTemplate: typing.Union['DashboardSlidesTemplate', schemas.Unset] = schemas.unset, + widgetSlidesTemplate: typing.Union['WidgetSlidesTemplate', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeExportTemplate': + return super().__new__( + cls, + *_args, + name=name, + id=id, + dashboardSlidesTemplate=dashboardSlidesTemplate, + widgetSlidesTemplate=widgetSlidesTemplate, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.dashboard_slides_template import DashboardSlidesTemplate +from gooddata_api_client.model.widget_slides_template import WidgetSlidesTemplate diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_export_templates.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_export_templates.pyi new file mode 100644 index 000000000..2bb432518 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_export_templates.pyi @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeExportTemplates( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Export templates. + """ + + + class MetaOapg: + required = { + "exportTemplates", + } + + class properties: + + + class exportTemplates( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeExportTemplate']: + return DeclarativeExportTemplate + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeExportTemplate'], typing.List['DeclarativeExportTemplate']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'exportTemplates': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeExportTemplate': + return super().__getitem__(i) + __annotations__ = { + "exportTemplates": exportTemplates, + } + + exportTemplates: MetaOapg.properties.exportTemplates + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["exportTemplates"]) -> MetaOapg.properties.exportTemplates: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["exportTemplates", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["exportTemplates"]) -> MetaOapg.properties.exportTemplates: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["exportTemplates", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + exportTemplates: typing.Union[MetaOapg.properties.exportTemplates, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeExportTemplates': + return super().__new__( + cls, + *_args, + exportTemplates=exportTemplates, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.declarative_export_template import DeclarativeExportTemplate diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_filter_view.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_filter_view.pyi new file mode 100644 index 000000000..571e28fe4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_filter_view.pyi @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeFilterView( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "id", + "title", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class title( + schemas.StrSchema + ): + pass + + @staticmethod + def analyticalDashboard() -> typing.Type['DeclarativeAnalyticalDashboardIdentifier']: + return DeclarativeAnalyticalDashboardIdentifier + + @staticmethod + def content() -> typing.Type['JsonNode']: + return JsonNode + + + class description( + schemas.StrSchema + ): + pass + isDefault = schemas.BoolSchema + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def user() -> typing.Type['DeclarativeUserIdentifier']: + return DeclarativeUserIdentifier + __annotations__ = { + "id": id, + "title": title, + "analyticalDashboard": analyticalDashboard, + "content": content, + "description": description, + "isDefault": isDefault, + "tags": tags, + "user": user, + } + + id: MetaOapg.properties.id + title: MetaOapg.properties.title + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> 'DeclarativeAnalyticalDashboardIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isDefault"]) -> MetaOapg.properties.isDefault: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["user"]) -> 'DeclarativeUserIdentifier': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "title", "analyticalDashboard", "content", "description", "isDefault", "tags", "user", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union['DeclarativeAnalyticalDashboardIdentifier', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isDefault"]) -> typing.Union[MetaOapg.properties.isDefault, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["user"]) -> typing.Union['DeclarativeUserIdentifier', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "title", "analyticalDashboard", "content", "description", "isDefault", "tags", "user", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + title: typing.Union[MetaOapg.properties.title, str, ], + analyticalDashboard: typing.Union['DeclarativeAnalyticalDashboardIdentifier', schemas.Unset] = schemas.unset, + content: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + isDefault: typing.Union[MetaOapg.properties.isDefault, bool, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + user: typing.Union['DeclarativeUserIdentifier', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeFilterView': + return super().__new__( + cls, + *_args, + id=id, + title=title, + analyticalDashboard=analyticalDashboard, + content=content, + description=description, + isDefault=isDefault, + tags=tags, + user=user, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.declarative_analytical_dashboard_identifier import DeclarativeAnalyticalDashboardIdentifier +from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_identity_provider.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_identity_provider.pyi new file mode 100644 index 000000000..598ba6437 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_identity_provider.pyi @@ -0,0 +1,363 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeIdentityProvider( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Notification channels. + """ + + + class MetaOapg: + required = { + "id", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class customClaimMapping( + schemas.DictSchema + ): + + + class MetaOapg: + additional_properties = schemas.StrSchema + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, str, ], + ) -> 'customClaimMapping': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class identifiers( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'identifiers': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class idpType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MANAGED_IDP(cls): + return cls("MANAGED_IDP") + + @schemas.classproperty + def FIM_IDP(cls): + return cls("FIM_IDP") + + @schemas.classproperty + def DEX_IDP(cls): + return cls("DEX_IDP") + + @schemas.classproperty + def CUSTOM_IDP(cls): + return cls("CUSTOM_IDP") + + + class oauthClientId( + schemas.StrSchema + ): + pass + + + class oauthClientSecret( + schemas.StrSchema + ): + pass + + + class oauthCustomAuthAttributes( + schemas.DictSchema + ): + + + class MetaOapg: + + + class additional_properties( + schemas.StrSchema + ): + pass + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, str, ], + ) -> 'oauthCustomAuthAttributes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class oauthCustomScopes( + schemas.ListBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneTupleMixin + ): + + + class MetaOapg: + + + class items( + schemas.StrSchema + ): + pass + + + def __new__( + cls, + *_args: typing.Union[list, tuple, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'oauthCustomScopes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class oauthIssuerId( + schemas.StrSchema + ): + pass + + + class oauthIssuerLocation( + schemas.StrSchema + ): + pass + + + class oauthSubjectIdClaim( + schemas.StrSchema + ): + pass + + + class samlMetadata( + schemas.StrSchema + ): + pass + __annotations__ = { + "id": id, + "customClaimMapping": customClaimMapping, + "identifiers": identifiers, + "idpType": idpType, + "oauthClientId": oauthClientId, + "oauthClientSecret": oauthClientSecret, + "oauthCustomAuthAttributes": oauthCustomAuthAttributes, + "oauthCustomScopes": oauthCustomScopes, + "oauthIssuerId": oauthIssuerId, + "oauthIssuerLocation": oauthIssuerLocation, + "oauthSubjectIdClaim": oauthSubjectIdClaim, + "samlMetadata": samlMetadata, + } + + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["customClaimMapping"]) -> MetaOapg.properties.customClaimMapping: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["identifiers"]) -> MetaOapg.properties.identifiers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["idpType"]) -> MetaOapg.properties.idpType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthClientId"]) -> MetaOapg.properties.oauthClientId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthClientSecret"]) -> MetaOapg.properties.oauthClientSecret: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthCustomAuthAttributes"]) -> MetaOapg.properties.oauthCustomAuthAttributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthCustomScopes"]) -> MetaOapg.properties.oauthCustomScopes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthIssuerId"]) -> MetaOapg.properties.oauthIssuerId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthIssuerLocation"]) -> MetaOapg.properties.oauthIssuerLocation: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthSubjectIdClaim"]) -> MetaOapg.properties.oauthSubjectIdClaim: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["samlMetadata"]) -> MetaOapg.properties.samlMetadata: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "customClaimMapping", "identifiers", "idpType", "oauthClientId", "oauthClientSecret", "oauthCustomAuthAttributes", "oauthCustomScopes", "oauthIssuerId", "oauthIssuerLocation", "oauthSubjectIdClaim", "samlMetadata", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["customClaimMapping"]) -> typing.Union[MetaOapg.properties.customClaimMapping, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["identifiers"]) -> typing.Union[MetaOapg.properties.identifiers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["idpType"]) -> typing.Union[MetaOapg.properties.idpType, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthClientId"]) -> typing.Union[MetaOapg.properties.oauthClientId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthClientSecret"]) -> typing.Union[MetaOapg.properties.oauthClientSecret, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthCustomAuthAttributes"]) -> typing.Union[MetaOapg.properties.oauthCustomAuthAttributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthCustomScopes"]) -> typing.Union[MetaOapg.properties.oauthCustomScopes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthIssuerId"]) -> typing.Union[MetaOapg.properties.oauthIssuerId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthIssuerLocation"]) -> typing.Union[MetaOapg.properties.oauthIssuerLocation, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthSubjectIdClaim"]) -> typing.Union[MetaOapg.properties.oauthSubjectIdClaim, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["samlMetadata"]) -> typing.Union[MetaOapg.properties.samlMetadata, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "customClaimMapping", "identifiers", "idpType", "oauthClientId", "oauthClientSecret", "oauthCustomAuthAttributes", "oauthCustomScopes", "oauthIssuerId", "oauthIssuerLocation", "oauthSubjectIdClaim", "samlMetadata", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + customClaimMapping: typing.Union[MetaOapg.properties.customClaimMapping, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + identifiers: typing.Union[MetaOapg.properties.identifiers, list, tuple, schemas.Unset] = schemas.unset, + idpType: typing.Union[MetaOapg.properties.idpType, str, schemas.Unset] = schemas.unset, + oauthClientId: typing.Union[MetaOapg.properties.oauthClientId, str, schemas.Unset] = schemas.unset, + oauthClientSecret: typing.Union[MetaOapg.properties.oauthClientSecret, str, schemas.Unset] = schemas.unset, + oauthCustomAuthAttributes: typing.Union[MetaOapg.properties.oauthCustomAuthAttributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + oauthCustomScopes: typing.Union[MetaOapg.properties.oauthCustomScopes, list, tuple, None, schemas.Unset] = schemas.unset, + oauthIssuerId: typing.Union[MetaOapg.properties.oauthIssuerId, str, schemas.Unset] = schemas.unset, + oauthIssuerLocation: typing.Union[MetaOapg.properties.oauthIssuerLocation, str, schemas.Unset] = schemas.unset, + oauthSubjectIdClaim: typing.Union[MetaOapg.properties.oauthSubjectIdClaim, str, schemas.Unset] = schemas.unset, + samlMetadata: typing.Union[MetaOapg.properties.samlMetadata, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeIdentityProvider': + return super().__new__( + cls, + *_args, + id=id, + customClaimMapping=customClaimMapping, + identifiers=identifiers, + idpType=idpType, + oauthClientId=oauthClientId, + oauthClientSecret=oauthClientSecret, + oauthCustomAuthAttributes=oauthCustomAuthAttributes, + oauthCustomScopes=oauthCustomScopes, + oauthIssuerId=oauthIssuerId, + oauthIssuerLocation=oauthIssuerLocation, + oauthSubjectIdClaim=oauthSubjectIdClaim, + samlMetadata=samlMetadata, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_identity_provider_identifier.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_identity_provider_identifier.pyi new file mode 100644 index 000000000..7e686a84b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_identity_provider_identifier.pyi @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeIdentityProviderIdentifier( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + An Identity Provider identifier. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def IDENTITY_PROVIDER(cls): + return cls("identityProvider") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeIdentityProviderIdentifier': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_jwk.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_jwk.pyi new file mode 100644 index 000000000..5d8e029c2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_jwk.pyi @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeJwk( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A declarative form of the JWK. + """ + + + class MetaOapg: + required = { + "id", + "content", + } + + class properties: + + @staticmethod + def content() -> typing.Type['DeclarativeJwkSpecification']: + return DeclarativeJwkSpecification + + + class id( + schemas.StrSchema + ): + pass + __annotations__ = { + "content": content, + "id": id, + } + + id: MetaOapg.properties.id + content: 'DeclarativeJwkSpecification' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> 'DeclarativeJwkSpecification': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["content", "id", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> 'DeclarativeJwkSpecification': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["content", "id", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + content: 'DeclarativeJwkSpecification', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeJwk': + return super().__new__( + cls, + *_args, + id=id, + content=content, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.declarative_jwk_specification import DeclarativeJwkSpecification diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_jwk_specification.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_jwk_specification.pyi new file mode 100644 index 000000000..c588bc561 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_jwk_specification.pyi @@ -0,0 +1,70 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeJwkSpecification( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Declarative specification of the cryptographic key. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + DeclarativeRsaSpecification, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeJwkSpecification': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.declarative_rsa_specification import DeclarativeRsaSpecification diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_label_translation.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_label_translation.pyi new file mode 100644 index 000000000..ad46004e9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_label_translation.pyi @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeLabelTranslation( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A label translation. + """ + + + class MetaOapg: + required = { + "locale", + "sourceColumn", + } + + class properties: + locale = schemas.StrSchema + sourceColumn = schemas.StrSchema + __annotations__ = { + "locale": locale, + "sourceColumn": sourceColumn, + } + + locale: MetaOapg.properties.locale + sourceColumn: MetaOapg.properties.sourceColumn + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["locale"]) -> MetaOapg.properties.locale: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sourceColumn"]) -> MetaOapg.properties.sourceColumn: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["locale", "sourceColumn", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["locale"]) -> MetaOapg.properties.locale: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sourceColumn"]) -> MetaOapg.properties.sourceColumn: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["locale", "sourceColumn", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + locale: typing.Union[MetaOapg.properties.locale, str, ], + sourceColumn: typing.Union[MetaOapg.properties.sourceColumn, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeLabelTranslation': + return super().__new__( + cls, + *_args, + locale=locale, + sourceColumn=sourceColumn, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_memory_item.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_memory_item.pyi new file mode 100644 index 000000000..bbf44285e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_memory_item.pyi @@ -0,0 +1,329 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeMemoryItem( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "instruction", + "id", + "strategy", + "title", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class instruction( + schemas.StrSchema + ): + pass + + + class strategy( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ALWAYS(cls): + return cls("ALWAYS") + + @schemas.classproperty + def AUTO(cls): + return cls("AUTO") + + + class title( + schemas.StrSchema + ): + pass + + + class createdAt( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'createdAt': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + @staticmethod + def createdBy() -> typing.Type['DeclarativeUserIdentifier']: + return DeclarativeUserIdentifier + + + class description( + schemas.StrSchema + ): + pass + isDisabled = schemas.BoolSchema + + + class keywords( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'keywords': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class modifiedAt( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'modifiedAt': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + @staticmethod + def modifiedBy() -> typing.Type['DeclarativeUserIdentifier']: + return DeclarativeUserIdentifier + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "id": id, + "instruction": instruction, + "strategy": strategy, + "title": title, + "createdAt": createdAt, + "createdBy": createdBy, + "description": description, + "isDisabled": isDisabled, + "keywords": keywords, + "modifiedAt": modifiedAt, + "modifiedBy": modifiedBy, + "tags": tags, + } + + instruction: MetaOapg.properties.instruction + id: MetaOapg.properties.id + strategy: MetaOapg.properties.strategy + title: MetaOapg.properties.title + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["instruction"]) -> MetaOapg.properties.instruction: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["strategy"]) -> MetaOapg.properties.strategy: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdAt"]) -> MetaOapg.properties.createdAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdBy"]) -> 'DeclarativeUserIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isDisabled"]) -> MetaOapg.properties.isDisabled: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["keywords"]) -> MetaOapg.properties.keywords: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedAt"]) -> MetaOapg.properties.modifiedAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedBy"]) -> 'DeclarativeUserIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "instruction", "strategy", "title", "createdAt", "createdBy", "description", "isDisabled", "keywords", "modifiedAt", "modifiedBy", "tags", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["instruction"]) -> MetaOapg.properties.instruction: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["strategy"]) -> MetaOapg.properties.strategy: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdAt"]) -> typing.Union[MetaOapg.properties.createdAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdBy"]) -> typing.Union['DeclarativeUserIdentifier', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isDisabled"]) -> typing.Union[MetaOapg.properties.isDisabled, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["keywords"]) -> typing.Union[MetaOapg.properties.keywords, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedAt"]) -> typing.Union[MetaOapg.properties.modifiedAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedBy"]) -> typing.Union['DeclarativeUserIdentifier', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "instruction", "strategy", "title", "createdAt", "createdBy", "description", "isDisabled", "keywords", "modifiedAt", "modifiedBy", "tags", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + instruction: typing.Union[MetaOapg.properties.instruction, str, ], + id: typing.Union[MetaOapg.properties.id, str, ], + strategy: typing.Union[MetaOapg.properties.strategy, str, ], + title: typing.Union[MetaOapg.properties.title, str, ], + createdAt: typing.Union[MetaOapg.properties.createdAt, None, str, schemas.Unset] = schemas.unset, + createdBy: typing.Union['DeclarativeUserIdentifier', schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + isDisabled: typing.Union[MetaOapg.properties.isDisabled, bool, schemas.Unset] = schemas.unset, + keywords: typing.Union[MetaOapg.properties.keywords, list, tuple, schemas.Unset] = schemas.unset, + modifiedAt: typing.Union[MetaOapg.properties.modifiedAt, None, str, schemas.Unset] = schemas.unset, + modifiedBy: typing.Union['DeclarativeUserIdentifier', schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeMemoryItem': + return super().__new__( + cls, + *_args, + instruction=instruction, + id=id, + strategy=strategy, + title=title, + createdAt=createdAt, + createdBy=createdBy, + description=description, + isDisabled=isDisabled, + keywords=keywords, + modifiedAt=modifiedAt, + modifiedBy=modifiedBy, + tags=tags, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier 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 dbc189a91..943f806a2 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_metric.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_metric.py @@ -62,6 +62,9 @@ class DeclarativeMetric(ModelNormal): """ allowed_values = { + ('certification',): { + 'CERTIFIED': "CERTIFIED", + }, } validations = { @@ -73,6 +76,11 @@ class DeclarativeMetric(ModelNormal): ('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 @@ -116,6 +124,10 @@ def openapi_types(): 'content': (JsonNode,), # noqa: E501 'id': (str,), # noqa: E501 'title': (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 'description': (str,), # noqa: E501 @@ -135,6 +147,10 @@ def discriminator(): 'content': 'content', # noqa: E501 'id': 'id', # noqa: E501 'title': 'title', # 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 'description': 'description', # noqa: E501 @@ -191,6 +207,10 @@ def _from_openapi_data(cls, content, 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,) + 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 description (str): Metric description.. [optional] # noqa: E501 @@ -292,6 +312,10 @@ def __init__(self, content, 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,) + 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 description (str): Metric description.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel.pyi new file mode 100644 index 000000000..adb04da09 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel.pyi @@ -0,0 +1,336 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeNotificationChannel( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A declarative form of a particular notification channel. + """ + + + class MetaOapg: + required = { + "id", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class allowedRecipients( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def CREATOR(cls): + return cls("CREATOR") + + @schemas.classproperty + def INTERNAL(cls): + return cls("INTERNAL") + + @schemas.classproperty + def EXTERNAL(cls): + return cls("EXTERNAL") + + + class customDashboardUrl( + schemas.StrSchema + ): + pass + + + class dashboardLinkVisibility( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def HIDDEN(cls): + return cls("HIDDEN") + + @schemas.classproperty + def INTERNAL_ONLY(cls): + return cls("INTERNAL_ONLY") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + + class description( + schemas.StrSchema + ): + pass + + + class destination( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + DefaultSmtp, + InPlatform, + Smtp, + Webhook, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'destination': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class destinationType( + schemas.EnumBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + enum_value_to_name = { + "WEBHOOK": "WEBHOOK", + "SMTP": "SMTP", + "DEFAULT_SMTP": "DEFAULT_SMTP", + "IN_PLATFORM": "IN_PLATFORM", + } + + @schemas.classproperty + def WEBHOOK(cls): + return cls("WEBHOOK") + + @schemas.classproperty + def SMTP(cls): + return cls("SMTP") + + @schemas.classproperty + def DEFAULT_SMTP(cls): + return cls("DEFAULT_SMTP") + + @schemas.classproperty + def IN_PLATFORM(cls): + return cls("IN_PLATFORM") + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'destinationType': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class inPlatformNotification( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DISABLED(cls): + return cls("DISABLED") + + @schemas.classproperty + def ENABLED(cls): + return cls("ENABLED") + + + class name( + schemas.StrSchema + ): + pass + + + class notificationSource( + schemas.StrSchema + ): + pass + __annotations__ = { + "id": id, + "allowedRecipients": allowedRecipients, + "customDashboardUrl": customDashboardUrl, + "dashboardLinkVisibility": dashboardLinkVisibility, + "description": description, + "destination": destination, + "destinationType": destinationType, + "inPlatformNotification": inPlatformNotification, + "name": name, + "notificationSource": notificationSource, + } + + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["allowedRecipients"]) -> MetaOapg.properties.allowedRecipients: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["customDashboardUrl"]) -> MetaOapg.properties.customDashboardUrl: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardLinkVisibility"]) -> MetaOapg.properties.dashboardLinkVisibility: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["destination"]) -> MetaOapg.properties.destination: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["destinationType"]) -> MetaOapg.properties.destinationType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["inPlatformNotification"]) -> MetaOapg.properties.inPlatformNotification: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["notificationSource"]) -> MetaOapg.properties.notificationSource: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "allowedRecipients", "customDashboardUrl", "dashboardLinkVisibility", "description", "destination", "destinationType", "inPlatformNotification", "name", "notificationSource", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["allowedRecipients"]) -> typing.Union[MetaOapg.properties.allowedRecipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["customDashboardUrl"]) -> typing.Union[MetaOapg.properties.customDashboardUrl, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardLinkVisibility"]) -> typing.Union[MetaOapg.properties.dashboardLinkVisibility, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["destination"]) -> typing.Union[MetaOapg.properties.destination, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["destinationType"]) -> typing.Union[MetaOapg.properties.destinationType, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["inPlatformNotification"]) -> typing.Union[MetaOapg.properties.inPlatformNotification, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["notificationSource"]) -> typing.Union[MetaOapg.properties.notificationSource, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "allowedRecipients", "customDashboardUrl", "dashboardLinkVisibility", "description", "destination", "destinationType", "inPlatformNotification", "name", "notificationSource", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + allowedRecipients: typing.Union[MetaOapg.properties.allowedRecipients, str, schemas.Unset] = schemas.unset, + customDashboardUrl: typing.Union[MetaOapg.properties.customDashboardUrl, str, schemas.Unset] = schemas.unset, + dashboardLinkVisibility: typing.Union[MetaOapg.properties.dashboardLinkVisibility, str, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + destination: typing.Union[MetaOapg.properties.destination, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + destinationType: typing.Union[MetaOapg.properties.destinationType, None, str, schemas.Unset] = schemas.unset, + inPlatformNotification: typing.Union[MetaOapg.properties.inPlatformNotification, str, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, str, schemas.Unset] = schemas.unset, + notificationSource: typing.Union[MetaOapg.properties.notificationSource, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeNotificationChannel': + return super().__new__( + cls, + *_args, + id=id, + allowedRecipients=allowedRecipients, + customDashboardUrl=customDashboardUrl, + dashboardLinkVisibility=dashboardLinkVisibility, + description=description, + destination=destination, + destinationType=destinationType, + inPlatformNotification=inPlatformNotification, + name=name, + notificationSource=notificationSource, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.default_smtp import DefaultSmtp +from gooddata_api_client.model.in_platform import InPlatform +from gooddata_api_client.model.smtp import Smtp +from gooddata_api_client.model.webhook import Webhook diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel_destination.py b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel_destination.py index e17135a3d..0d4905d4d 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel_destination.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel_destination.py @@ -78,6 +78,10 @@ class DeclarativeNotificationChannelDestination(ModelComposed): } validations = { + ('has_secret_key',): { + }, + ('has_token',): { + }, ('secret_key',): { 'max_length': 10000, }, diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel_identifier.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel_identifier.pyi new file mode 100644 index 000000000..4b98e387b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel_identifier.pyi @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeNotificationChannelIdentifier( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A notification channel identifier. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeNotificationChannelIdentifier': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channels.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channels.pyi new file mode 100644 index 000000000..8492ab28f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channels.pyi @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeNotificationChannels( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Notification channels. + """ + + + class MetaOapg: + required = { + "notificationChannels", + } + + class properties: + + + class notificationChannels( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeNotificationChannel']: + return DeclarativeNotificationChannel + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeNotificationChannel'], typing.List['DeclarativeNotificationChannel']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'notificationChannels': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeNotificationChannel': + return super().__getitem__(i) + __annotations__ = { + "notificationChannels": notificationChannels, + } + + notificationChannels: MetaOapg.properties.notificationChannels + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["notificationChannels"]) -> MetaOapg.properties.notificationChannels: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["notificationChannels", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["notificationChannels"]) -> MetaOapg.properties.notificationChannels: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["notificationChannels", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + notificationChannels: typing.Union[MetaOapg.properties.notificationChannels, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeNotificationChannels': + return super().__new__( + cls, + *_args, + notificationChannels=notificationChannels, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.declarative_notification_channel import DeclarativeNotificationChannel diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_reference_source.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_reference_source.pyi new file mode 100644 index 000000000..273d998d9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_reference_source.pyi @@ -0,0 +1,171 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeReferenceSource( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A dataset reference source column description. + """ + + + class MetaOapg: + required = { + "column", + "target", + } + + class properties: + + + class column( + schemas.StrSchema + ): + pass + + @staticmethod + def target() -> typing.Type['GrainIdentifier']: + return GrainIdentifier + + + class dataType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INT(cls): + return cls("INT") + + @schemas.classproperty + def STRING(cls): + return cls("STRING") + + @schemas.classproperty + def DATE(cls): + return cls("DATE") + + @schemas.classproperty + def NUMERIC(cls): + return cls("NUMERIC") + + @schemas.classproperty + def TIMESTAMP(cls): + return cls("TIMESTAMP") + + @schemas.classproperty + def TIMESTAMP_TZ(cls): + return cls("TIMESTAMP_TZ") + + @schemas.classproperty + def BOOLEAN(cls): + return cls("BOOLEAN") + isNullable = schemas.BoolSchema + nullValue = schemas.StrSchema + __annotations__ = { + "column": column, + "target": target, + "dataType": dataType, + "isNullable": isNullable, + "nullValue": nullValue, + } + + column: MetaOapg.properties.column + target: 'GrainIdentifier' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["column"]) -> MetaOapg.properties.column: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["target"]) -> 'GrainIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataType"]) -> MetaOapg.properties.dataType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isNullable"]) -> MetaOapg.properties.isNullable: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["nullValue"]) -> MetaOapg.properties.nullValue: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["column", "target", "dataType", "isNullable", "nullValue", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["column"]) -> MetaOapg.properties.column: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["target"]) -> 'GrainIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataType"]) -> typing.Union[MetaOapg.properties.dataType, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isNullable"]) -> typing.Union[MetaOapg.properties.isNullable, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["nullValue"]) -> typing.Union[MetaOapg.properties.nullValue, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["column", "target", "dataType", "isNullable", "nullValue", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + column: typing.Union[MetaOapg.properties.column, str, ], + target: 'GrainIdentifier', + dataType: typing.Union[MetaOapg.properties.dataType, str, schemas.Unset] = schemas.unset, + isNullable: typing.Union[MetaOapg.properties.isNullable, bool, schemas.Unset] = schemas.unset, + nullValue: typing.Union[MetaOapg.properties.nullValue, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeReferenceSource': + return super().__new__( + cls, + *_args, + column=column, + target=target, + dataType=dataType, + isNullable=isNullable, + nullValue=nullValue, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.grain_identifier import GrainIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_rsa_specification.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_rsa_specification.pyi new file mode 100644 index 000000000..932f99254 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_rsa_specification.pyi @@ -0,0 +1,228 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeRsaSpecification( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Declarative specification of the cryptographic key. + """ + + + class MetaOapg: + required = { + "kty", + "e", + "use", + "kid", + "alg", + "n", + } + + class properties: + + + class alg( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def RS256(cls): + return cls("RS256") + + @schemas.classproperty + def RS384(cls): + return cls("RS384") + + @schemas.classproperty + def RS512(cls): + return cls("RS512") + e = schemas.StrSchema + + + class kid( + schemas.StrSchema + ): + pass + + + class kty( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def RSA(cls): + return cls("RSA") + n = schemas.StrSchema + + + class use( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SIG(cls): + return cls("sig") + + + class x5c( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'x5c': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + x5t = schemas.StrSchema + __annotations__ = { + "alg": alg, + "e": e, + "kid": kid, + "kty": kty, + "n": n, + "use": use, + "x5c": x5c, + "x5t": x5t, + } + + kty: MetaOapg.properties.kty + e: MetaOapg.properties.e + use: MetaOapg.properties.use + kid: MetaOapg.properties.kid + alg: MetaOapg.properties.alg + n: MetaOapg.properties.n + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["alg"]) -> MetaOapg.properties.alg: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["e"]) -> MetaOapg.properties.e: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["kid"]) -> MetaOapg.properties.kid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["kty"]) -> MetaOapg.properties.kty: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["n"]) -> MetaOapg.properties.n: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["use"]) -> MetaOapg.properties.use: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["x5c"]) -> MetaOapg.properties.x5c: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["x5t"]) -> MetaOapg.properties.x5t: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["alg", "e", "kid", "kty", "n", "use", "x5c", "x5t", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["alg"]) -> MetaOapg.properties.alg: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["e"]) -> MetaOapg.properties.e: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["kid"]) -> MetaOapg.properties.kid: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["kty"]) -> MetaOapg.properties.kty: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["n"]) -> MetaOapg.properties.n: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["use"]) -> MetaOapg.properties.use: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["x5c"]) -> typing.Union[MetaOapg.properties.x5c, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["x5t"]) -> typing.Union[MetaOapg.properties.x5t, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["alg", "e", "kid", "kty", "n", "use", "x5c", "x5t", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + kty: typing.Union[MetaOapg.properties.kty, str, ], + e: typing.Union[MetaOapg.properties.e, str, ], + use: typing.Union[MetaOapg.properties.use, str, ], + kid: typing.Union[MetaOapg.properties.kid, str, ], + alg: typing.Union[MetaOapg.properties.alg, str, ], + n: typing.Union[MetaOapg.properties.n, str, ], + x5c: typing.Union[MetaOapg.properties.x5c, list, tuple, schemas.Unset] = schemas.unset, + x5t: typing.Union[MetaOapg.properties.x5t, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeRsaSpecification': + return super().__new__( + cls, + *_args, + kty=kty, + e=e, + use=use, + kid=kid, + alg=alg, + n=n, + x5c=x5c, + x5t=x5t, + _configuration=_configuration, + **kwargs, + ) 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 618aafc61..68d5cc622 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_setting.py @@ -65,6 +65,7 @@ class DeclarativeSetting(ModelNormal): 'ACTIVE_THEME': "ACTIVE_THEME", 'ACTIVE_COLOR_PALETTE': "ACTIVE_COLOR_PALETTE", 'ACTIVE_LLM_ENDPOINT': "ACTIVE_LLM_ENDPOINT", + 'ACTIVE_LLM_PROVIDER': "ACTIVE_LLM_PROVIDER", 'ACTIVE_CALENDARS': "ACTIVE_CALENDARS", 'WHITE_LABELING': "WHITE_LABELING", 'LOCALE': "LOCALE", @@ -108,6 +109,7 @@ class DeclarativeSetting(ModelNormal): '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", }, } 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 ac9f1cd2e..eb8a42df5 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 @@ -68,6 +68,8 @@ class DeclarativeSingleWorkspacePermission(ModelNormal): 'EXPORT_PDF': "EXPORT_PDF", 'CREATE_AUTOMATION': "CREATE_AUTOMATION", 'USE_AI_ASSISTANT': "USE_AI_ASSISTANT", + 'WRITE_KNOWLEDGE_DOCUMENTS': "WRITE_KNOWLEDGE_DOCUMENTS", + 'READ_KNOWLEDGE_DOCUMENTS': "READ_KNOWLEDGE_DOCUMENTS", 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", 'VIEW': "VIEW", }, diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_source_fact_reference.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_source_fact_reference.pyi new file mode 100644 index 000000000..68c45656c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_source_fact_reference.pyi @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeSourceFactReference( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Aggregated awareness source fact reference. + """ + + + class MetaOapg: + required = { + "reference", + "operation", + } + + class properties: + + + class operation( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SUM(cls): + return cls("SUM") + + @schemas.classproperty + def MIN(cls): + return cls("MIN") + + @schemas.classproperty + def MAX(cls): + return cls("MAX") + + @staticmethod + def reference() -> typing.Type['FactIdentifier']: + return FactIdentifier + __annotations__ = { + "operation": operation, + "reference": reference, + } + + reference: 'FactIdentifier' + operation: MetaOapg.properties.operation + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["operation"]) -> MetaOapg.properties.operation: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["reference"]) -> 'FactIdentifier': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["operation", "reference", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["operation"]) -> MetaOapg.properties.operation: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["reference"]) -> 'FactIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["operation", "reference", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + reference: 'FactIdentifier', + operation: typing.Union[MetaOapg.properties.operation, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeSourceFactReference': + return super().__new__( + cls, + *_args, + reference=reference, + operation=operation, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.fact_identifier import FactIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_group_identifier.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_user_group_identifier.pyi new file mode 100644 index 000000000..bf5ef3aac --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_user_group_identifier.pyi @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeUserGroupIdentifier( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A user group identifier. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def USER_GROUP(cls): + return cls("userGroup") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeUserGroupIdentifier': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_user_identifier.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_user_identifier.pyi new file mode 100644 index 000000000..bd52bcf45 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_user_identifier.pyi @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeUserIdentifier( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A user identifier. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def USER(cls): + return cls("user") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeUserIdentifier': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) 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 bf0537806..0bfbaf70c 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 @@ -62,6 +62,9 @@ class DeclarativeVisualizationObject(ModelNormal): """ allowed_values = { + ('certification',): { + 'CERTIFIED': "CERTIFIED", + }, } validations = { @@ -73,6 +76,11 @@ class DeclarativeVisualizationObject(ModelNormal): ('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 @@ -116,6 +124,10 @@ def openapi_types(): 'content': (JsonNode,), # noqa: E501 'id': (str,), # noqa: E501 'title': (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 'description': (str,), # noqa: E501 @@ -134,6 +146,10 @@ def discriminator(): 'content': 'content', # noqa: E501 'id': 'id', # noqa: E501 'title': 'title', # 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 'description': 'description', # noqa: E501 @@ -189,6 +205,10 @@ def _from_openapi_data(cls, content, 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,) + 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 description (str): Visualization object description.. [optional] # noqa: E501 @@ -289,6 +309,10 @@ def __init__(self, content, 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,) + 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 description (str): Visualization object description.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter_references.pyi b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter_references.pyi new file mode 100644 index 000000000..6cba6df4e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_data_filter_references.pyi @@ -0,0 +1,146 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeclarativeWorkspaceDataFilterReferences( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "filterId", + "filterColumnDataType", + "filterColumn", + } + + class properties: + filterColumn = schemas.StrSchema + + + class filterColumnDataType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INT(cls): + return cls("INT") + + @schemas.classproperty + def STRING(cls): + return cls("STRING") + + @schemas.classproperty + def DATE(cls): + return cls("DATE") + + @schemas.classproperty + def NUMERIC(cls): + return cls("NUMERIC") + + @schemas.classproperty + def TIMESTAMP(cls): + return cls("TIMESTAMP") + + @schemas.classproperty + def TIMESTAMP_TZ(cls): + return cls("TIMESTAMP_TZ") + + @schemas.classproperty + def BOOLEAN(cls): + return cls("BOOLEAN") + + @staticmethod + def filterId() -> typing.Type['DatasetWorkspaceDataFilterIdentifier']: + return DatasetWorkspaceDataFilterIdentifier + __annotations__ = { + "filterColumn": filterColumn, + "filterColumnDataType": filterColumnDataType, + "filterId": filterId, + } + + filterId: 'DatasetWorkspaceDataFilterIdentifier' + filterColumnDataType: MetaOapg.properties.filterColumnDataType + filterColumn: MetaOapg.properties.filterColumn + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filterColumn"]) -> MetaOapg.properties.filterColumn: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filterColumnDataType"]) -> MetaOapg.properties.filterColumnDataType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filterId"]) -> 'DatasetWorkspaceDataFilterIdentifier': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["filterColumn", "filterColumnDataType", "filterId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filterColumn"]) -> MetaOapg.properties.filterColumn: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filterColumnDataType"]) -> MetaOapg.properties.filterColumnDataType: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filterId"]) -> 'DatasetWorkspaceDataFilterIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["filterColumn", "filterColumnDataType", "filterId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + filterId: 'DatasetWorkspaceDataFilterIdentifier', + filterColumnDataType: typing.Union[MetaOapg.properties.filterColumnDataType, str, ], + filterColumn: typing.Union[MetaOapg.properties.filterColumn, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeclarativeWorkspaceDataFilterReferences': + return super().__new__( + cls, + *_args, + filterId=filterId, + filterColumnDataType=filterColumnDataType, + filterColumn=filterColumn, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.dataset_workspace_data_filter_identifier import DatasetWorkspaceDataFilterIdentifier 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 854309a92..cecaa382e 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 @@ -68,6 +68,8 @@ class DeclarativeWorkspaceHierarchyPermission(ModelNormal): 'EXPORT_PDF': "EXPORT_PDF", 'CREATE_AUTOMATION': "CREATE_AUTOMATION", 'USE_AI_ASSISTANT': "USE_AI_ASSISTANT", + 'WRITE_KNOWLEDGE_DOCUMENTS': "WRITE_KNOWLEDGE_DOCUMENTS", + 'READ_KNOWLEDGE_DOCUMENTS': "READ_KNOWLEDGE_DOCUMENTS", 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", 'VIEW': "VIEW", }, diff --git a/gooddata-api-client/gooddata_api_client/model/default_smtp.pyi b/gooddata-api-client/gooddata_api_client/model/default_smtp.pyi new file mode 100644 index 000000000..98659efd9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/default_smtp.pyi @@ -0,0 +1,210 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DefaultSmtp( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Default SMTP destination for notifications. + """ + + + class MetaOapg: + required = { + "type", + } + + class properties: + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DEFAULT_SMTP(cls): + return cls("DEFAULT_SMTP") + fromEmail = schemas.StrSchema + fromEmailName = schemas.StrSchema + __annotations__ = { + "type": type, + "fromEmail": fromEmail, + "fromEmailName": fromEmailName, + } + + + class all_of_0( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + fromEmail = schemas.StrSchema + fromEmailName = schemas.StrSchema + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DEFAULT_SMTP(cls): + return cls("DEFAULT_SMTP") + __annotations__ = { + "fromEmail": fromEmail, + "fromEmailName": fromEmailName, + "type": type, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fromEmail"]) -> MetaOapg.properties.fromEmail: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fromEmailName"]) -> MetaOapg.properties.fromEmailName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["fromEmail", "fromEmailName", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fromEmail"]) -> typing.Union[MetaOapg.properties.fromEmail, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fromEmailName"]) -> typing.Union[MetaOapg.properties.fromEmailName, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> typing.Union[MetaOapg.properties.type, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["fromEmail", "fromEmailName", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + fromEmail: typing.Union[MetaOapg.properties.fromEmail, str, schemas.Unset] = schemas.unset, + fromEmailName: typing.Union[MetaOapg.properties.fromEmailName, str, schemas.Unset] = schemas.unset, + type: typing.Union[MetaOapg.properties.type, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + fromEmail=fromEmail, + fromEmailName=fromEmailName, + type=type, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + ] + + + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fromEmail"]) -> MetaOapg.properties.fromEmail: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fromEmailName"]) -> MetaOapg.properties.fromEmailName: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["type", "fromEmail", "fromEmailName", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fromEmail"]) -> typing.Union[MetaOapg.properties.fromEmail, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fromEmailName"]) -> typing.Union[MetaOapg.properties.fromEmailName, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["type", "fromEmail", "fromEmailName", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + fromEmail: typing.Union[MetaOapg.properties.fromEmail, str, schemas.Unset] = schemas.unset, + fromEmailName: typing.Union[MetaOapg.properties.fromEmailName, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DefaultSmtp': + return super().__new__( + cls, + *_args, + type=type, + fromEmail=fromEmail, + fromEmailName=fromEmailName, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/delete_knowledge_document_response_dto.py b/gooddata-api-client/gooddata_api_client/model/delete_knowledge_document_response_dto.py new file mode 100644 index 000000000..6508e4243 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/delete_knowledge_document_response_dto.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class DeleteKnowledgeDocumentResponseDto(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 + 'success': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'message': 'message', # noqa: E501 + 'success': 'success', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, message, success, *args, **kwargs): # noqa: E501 + """DeleteKnowledgeDocumentResponseDto - a model defined in OpenAPI + + Args: + message (str): + success (bool): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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.success = success + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = 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, success, *args, **kwargs): # noqa: E501 + """DeleteKnowledgeDocumentResponseDto - a model defined in OpenAPI + + Args: + message (str): + success (bool): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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.success = success + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/delete_knowledge_document_response_dto.pyi b/gooddata-api-client/gooddata_api_client/model/delete_knowledge_document_response_dto.pyi new file mode 100644 index 000000000..773b2b732 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/delete_knowledge_document_response_dto.pyi @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DeleteKnowledgeDocumentResponseDto( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "success", + "message", + } + + class properties: + message = schemas.StrSchema + success = schemas.BoolSchema + __annotations__ = { + "message": message, + "success": success, + } + + success: MetaOapg.properties.success + message: MetaOapg.properties.message + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["message"]) -> MetaOapg.properties.message: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["success"]) -> MetaOapg.properties.success: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["message", "success", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["message"]) -> MetaOapg.properties.message: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["success"]) -> MetaOapg.properties.success: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["message", "success", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + success: typing.Union[MetaOapg.properties.success, bool, ], + message: typing.Union[MetaOapg.properties.message, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DeleteKnowledgeDocumentResponseDto': + return super().__new__( + cls, + *_args, + success=success, + message=message, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/dependent_entities_request.py b/gooddata-api-client/gooddata_api_client/model/dependent_entities_request.py index 38c1583db..dd438de8d 100644 --- a/gooddata-api-client/gooddata_api_client/model/dependent_entities_request.py +++ b/gooddata-api-client/gooddata_api_client/model/dependent_entities_request.py @@ -60,6 +60,10 @@ class DependentEntitiesRequest(ModelNormal): """ allowed_values = { + ('relation',): { + 'DEPENDENTS': "DEPENDENTS", + 'DEPENDENCIES': "DEPENDENCIES", + }, } validations = { @@ -89,6 +93,7 @@ def openapi_types(): lazy_import() return { 'identifiers': ([EntityIdentifier],), # noqa: E501 + 'relation': (str,), # noqa: E501 } @cached_property @@ -98,6 +103,7 @@ def discriminator(): attribute_map = { 'identifiers': 'identifiers', # noqa: E501 + 'relation': 'relation', # noqa: E501 } read_only_vars = { @@ -144,6 +150,7 @@ def _from_openapi_data(cls, identifiers, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + relation (str): Entity relation for graph traversal from the entry points. DEPENDENTS returns entities that depend on the entry points. DEPENDENCIES returns entities that the entry points depend on.. [optional] if omitted the server will use the default value of "DEPENDENTS" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -233,6 +240,7 @@ def __init__(self, identifiers, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + relation (str): Entity relation for graph traversal from the entry points. DEPENDENTS returns entities that depend on the entry points. DEPENDENCIES returns entities that the entry points depend on.. [optional] if omitted the server will use the default value of "DEPENDENTS" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/depends_on.pyi b/gooddata-api-client/gooddata_api_client/model/depends_on.pyi new file mode 100644 index 000000000..9800f5ad3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/depends_on.pyi @@ -0,0 +1,189 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DependsOn( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Filter definition type specified by label and values. + """ + + + class MetaOapg: + required = { + "values", + "label", + } + + + class all_of_1( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + complementFilter = schemas.BoolSchema + label = schemas.StrSchema + + + class values( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, None, str, ]], typing.List[typing.Union[MetaOapg.items, None, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'values': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "complementFilter": complementFilter, + "label": label, + "values": values, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["complementFilter"]) -> MetaOapg.properties.complementFilter: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["label"]) -> MetaOapg.properties.label: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["values"]) -> MetaOapg.properties.values: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["complementFilter", "label", "values", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["complementFilter"]) -> typing.Union[MetaOapg.properties.complementFilter, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["label"]) -> typing.Union[MetaOapg.properties.label, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["values"]) -> typing.Union[MetaOapg.properties.values, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["complementFilter", "label", "values", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + complementFilter: typing.Union[MetaOapg.properties.complementFilter, bool, schemas.Unset] = schemas.unset, + label: typing.Union[MetaOapg.properties.label, str, schemas.Unset] = schemas.unset, + values: typing.Union[MetaOapg.properties.values, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + complementFilter=complementFilter, + label=label, + values=values, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + DependsOnItem, + cls.all_of_1, + ] + + + values: schemas.AnyTypeSchema + label: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DependsOn': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.depends_on_item import DependsOnItem diff --git a/gooddata-api-client/gooddata_api_client/model/depends_on_date_filter.pyi b/gooddata-api-client/gooddata_api_client/model/depends_on_date_filter.pyi new file mode 100644 index 000000000..05ae10813 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/depends_on_date_filter.pyi @@ -0,0 +1,130 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DependsOnDateFilter( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Filter definition type for dates. + """ + + + class MetaOapg: + required = { + "dateFilter", + } + + + class all_of_1( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def dateFilter() -> typing.Type['DateFilter']: + return DateFilter + __annotations__ = { + "dateFilter": dateFilter, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dateFilter"]) -> 'DateFilter': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dateFilter", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dateFilter"]) -> typing.Union['DateFilter', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dateFilter", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + dateFilter: typing.Union['DateFilter', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + dateFilter=dateFilter, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + DependsOnItem, + cls.all_of_1, + ] + + + dateFilter: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DependsOnDateFilter': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.date_filter import DateFilter +from gooddata_api_client.model.depends_on_item import DependsOnItem diff --git a/gooddata-api-client/gooddata_api_client/model/depends_on_item.pyi b/gooddata-api-client/gooddata_api_client/model/depends_on_item.pyi new file mode 100644 index 000000000..fd90e25e4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/depends_on_item.pyi @@ -0,0 +1,51 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DependsOnItem( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DependsOnItem': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/dim_attribute.pyi b/gooddata-api-client/gooddata_api_client/model/dim_attribute.pyi new file mode 100644 index 000000000..08dd72160 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/dim_attribute.pyi @@ -0,0 +1,119 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class DimAttribute( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + List of attributes representing the dimensionality of the new visualization + """ + + + class MetaOapg: + required = { + "id", + "title", + "type", + } + + class properties: + id = schemas.StrSchema + title = schemas.StrSchema + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ATTRIBUTE(cls): + return cls("attribute") + __annotations__ = { + "id": id, + "title": title, + "type": type, + } + + id: MetaOapg.properties.id + title: MetaOapg.properties.title + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "title", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "title", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + title: typing.Union[MetaOapg.properties.title, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'DimAttribute': + return super().__new__( + cls, + *_args, + id=id, + title=title, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/entity_search_body.pyi b/gooddata-api-client/gooddata_api_client/model/entity_search_body.pyi new file mode 100644 index 000000000..74740bf0d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/entity_search_body.pyi @@ -0,0 +1,218 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class EntitySearchBody( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Request body for entity search operations + """ + + + class MetaOapg: + + class properties: + + + class filter( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'filter': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class include( + schemas.ListBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneTupleMixin + ): + + + class MetaOapg: + items = schemas.StrSchema + + + def __new__( + cls, + *_args: typing.Union[list, tuple, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'include': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class metaInclude( + schemas.ListBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneTupleMixin + ): + + + class MetaOapg: + items = schemas.StrSchema + + + def __new__( + cls, + *_args: typing.Union[list, tuple, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'metaInclude': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + @staticmethod + def page() -> typing.Type['EntitySearchPage']: + return EntitySearchPage + + + class sort( + schemas.ListBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneTupleMixin + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['EntitySearchSort']: + return EntitySearchSort + + + def __new__( + cls, + *_args: typing.Union[list, tuple, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'sort': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + __annotations__ = { + "filter": filter, + "include": include, + "metaInclude": metaInclude, + "page": page, + "sort": sort, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filter"]) -> MetaOapg.properties.filter: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["include"]) -> MetaOapg.properties.include: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metaInclude"]) -> MetaOapg.properties.metaInclude: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'EntitySearchPage': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sort"]) -> MetaOapg.properties.sort: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["filter", "include", "metaInclude", "page", "sort", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filter"]) -> typing.Union[MetaOapg.properties.filter, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["include"]) -> typing.Union[MetaOapg.properties.include, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metaInclude"]) -> typing.Union[MetaOapg.properties.metaInclude, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['EntitySearchPage', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sort"]) -> typing.Union[MetaOapg.properties.sort, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["filter", "include", "metaInclude", "page", "sort", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + filter: typing.Union[MetaOapg.properties.filter, None, str, schemas.Unset] = schemas.unset, + include: typing.Union[MetaOapg.properties.include, list, tuple, None, schemas.Unset] = schemas.unset, + metaInclude: typing.Union[MetaOapg.properties.metaInclude, list, tuple, None, schemas.Unset] = schemas.unset, + page: typing.Union['EntitySearchPage', schemas.Unset] = schemas.unset, + sort: typing.Union[MetaOapg.properties.sort, list, tuple, None, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'EntitySearchBody': + return super().__new__( + cls, + *_args, + filter=filter, + include=include, + metaInclude=metaInclude, + page=page, + sort=sort, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.entity_search_page import EntitySearchPage +from gooddata_api_client.model.entity_search_sort import EntitySearchSort diff --git a/gooddata-api-client/gooddata_api_client/model/entity_search_page.pyi b/gooddata-api-client/gooddata_api_client/model/entity_search_page.pyi new file mode 100644 index 000000000..2ef2aff1d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/entity_search_page.pyi @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class EntitySearchPage( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Pagination information for entity search + """ + + + class MetaOapg: + required = { + "size", + "index", + } + + class properties: + + + class index( + schemas.Int32Schema + ): + pass + + + class size( + schemas.Int32Schema + ): + pass + __annotations__ = { + "index": index, + "size": size, + } + + size: MetaOapg.properties.size + index: MetaOapg.properties.index + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["index"]) -> MetaOapg.properties.index: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["size"]) -> MetaOapg.properties.size: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["index", "size", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["index"]) -> MetaOapg.properties.index: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["size"]) -> MetaOapg.properties.size: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["index", "size", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + size: typing.Union[MetaOapg.properties.size, decimal.Decimal, int, ], + index: typing.Union[MetaOapg.properties.index, decimal.Decimal, int, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'EntitySearchPage': + return super().__new__( + cls, + *_args, + size=size, + index=index, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/entity_search_sort.pyi b/gooddata-api-client/gooddata_api_client/model/entity_search_sort.pyi new file mode 100644 index 000000000..bebcdf582 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/entity_search_sort.pyi @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class EntitySearchSort( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Sorting criteria for entity search + """ + + + class MetaOapg: + required = { + "property", + } + + class properties: + _property = schemas.StrSchema + + + class direction( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ASC(cls): + return cls("ASC") + + @schemas.classproperty + def DESC(cls): + return cls("DESC") + __annotations__ = { + "property": _property, + "direction": direction, + } + + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["property"]) -> MetaOapg.properties._property: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["direction"]) -> MetaOapg.properties.direction: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["property", "direction", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["property"]) -> MetaOapg.properties._property: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["direction"]) -> typing.Union[MetaOapg.properties.direction, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["property", "direction", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + direction: typing.Union[MetaOapg.properties.direction, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'EntitySearchSort': + return super().__new__( + cls, + *_args, + direction=direction, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/execution_result_data_source_message.pyi b/gooddata-api-client/gooddata_api_client/model/execution_result_data_source_message.pyi new file mode 100644 index 000000000..27f3cd676 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/execution_result_data_source_message.pyi @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ExecutionResultDataSourceMessage( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A piece of extra information related to the results (e.g. debug information, warnings, etc.). + """ + + + class MetaOapg: + required = { + "correlationId", + "source", + "type", + } + + class properties: + correlationId = schemas.StrSchema + source = schemas.StrSchema + type = schemas.StrSchema + data = schemas.DictSchema + __annotations__ = { + "correlationId": correlationId, + "source": source, + "type": type, + "data": data, + } + + correlationId: MetaOapg.properties.correlationId + source: MetaOapg.properties.source + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["correlationId"]) -> MetaOapg.properties.correlationId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["source"]) -> MetaOapg.properties.source: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["correlationId", "source", "type", "data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["correlationId"]) -> MetaOapg.properties.correlationId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["source"]) -> MetaOapg.properties.source: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> typing.Union[MetaOapg.properties.data, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["correlationId", "source", "type", "data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + correlationId: typing.Union[MetaOapg.properties.correlationId, str, ], + source: typing.Union[MetaOapg.properties.source, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + data: typing.Union[MetaOapg.properties.data, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ExecutionResultDataSourceMessage': + return super().__new__( + cls, + *_args, + correlationId=correlationId, + source=source, + type=type, + data=data, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/execution_result_metadata.pyi b/gooddata-api-client/gooddata_api_client/model/execution_result_metadata.pyi new file mode 100644 index 000000000..389570d65 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/execution_result_metadata.pyi @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ExecutionResultMetadata( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Additional metadata for the particular execution result. + """ + + + class MetaOapg: + required = { + "dataSourceMessages", + } + + class properties: + + + class dataSourceMessages( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ExecutionResultDataSourceMessage']: + return ExecutionResultDataSourceMessage + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['ExecutionResultDataSourceMessage'], typing.List['ExecutionResultDataSourceMessage']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dataSourceMessages': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ExecutionResultDataSourceMessage': + return super().__getitem__(i) + __annotations__ = { + "dataSourceMessages": dataSourceMessages, + } + + dataSourceMessages: MetaOapg.properties.dataSourceMessages + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataSourceMessages"]) -> MetaOapg.properties.dataSourceMessages: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataSourceMessages", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataSourceMessages"]) -> MetaOapg.properties.dataSourceMessages: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataSourceMessages", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + dataSourceMessages: typing.Union[MetaOapg.properties.dataSourceMessages, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ExecutionResultMetadata': + return super().__new__( + cls, + *_args, + dataSourceMessages=dataSourceMessages, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.execution_result_data_source_message import ExecutionResultDataSourceMessage diff --git a/gooddata-api-client/gooddata_api_client/model/export_request.pyi b/gooddata-api-client/gooddata_api_client/model/export_request.pyi new file mode 100644 index 000000000..e9ec0cc0a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/export_request.pyi @@ -0,0 +1,72 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ExportRequest( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + VisualExportRequest, + TabularExportRequest, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ExportRequest': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.model.visual_export_request import VisualExportRequest diff --git a/gooddata-api-client/gooddata_api_client/model/export_result.pyi b/gooddata-api-client/gooddata_api_client/model/export_result.pyi new file mode 100644 index 000000000..bc8af1a2c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/export_result.pyi @@ -0,0 +1,189 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ExportResult( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "fileName", + "exportId", + "status", + } + + class properties: + exportId = schemas.StrSchema + fileName = schemas.StrSchema + + + class status( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SUCCESS(cls): + return cls("SUCCESS") + + @schemas.classproperty + def ERROR(cls): + return cls("ERROR") + + @schemas.classproperty + def INTERNAL_ERROR(cls): + return cls("INTERNAL_ERROR") + + @schemas.classproperty + def TIMEOUT(cls): + return cls("TIMEOUT") + errorMessage = schemas.StrSchema + expiresAt = schemas.DateTimeSchema + fileSize = schemas.Int64Schema + fileUri = schemas.StrSchema + traceId = schemas.StrSchema + triggeredAt = schemas.DateTimeSchema + __annotations__ = { + "exportId": exportId, + "fileName": fileName, + "status": status, + "errorMessage": errorMessage, + "expiresAt": expiresAt, + "fileSize": fileSize, + "fileUri": fileUri, + "traceId": traceId, + "triggeredAt": triggeredAt, + } + + fileName: MetaOapg.properties.fileName + exportId: MetaOapg.properties.exportId + status: MetaOapg.properties.status + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["exportId"]) -> MetaOapg.properties.exportId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["errorMessage"]) -> MetaOapg.properties.errorMessage: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["expiresAt"]) -> MetaOapg.properties.expiresAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fileSize"]) -> MetaOapg.properties.fileSize: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fileUri"]) -> MetaOapg.properties.fileUri: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["traceId"]) -> MetaOapg.properties.traceId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["triggeredAt"]) -> MetaOapg.properties.triggeredAt: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["exportId", "fileName", "status", "errorMessage", "expiresAt", "fileSize", "fileUri", "traceId", "triggeredAt", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["exportId"]) -> MetaOapg.properties.exportId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["errorMessage"]) -> typing.Union[MetaOapg.properties.errorMessage, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["expiresAt"]) -> typing.Union[MetaOapg.properties.expiresAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fileSize"]) -> typing.Union[MetaOapg.properties.fileSize, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fileUri"]) -> typing.Union[MetaOapg.properties.fileUri, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["traceId"]) -> typing.Union[MetaOapg.properties.traceId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["triggeredAt"]) -> typing.Union[MetaOapg.properties.triggeredAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["exportId", "fileName", "status", "errorMessage", "expiresAt", "fileSize", "fileUri", "traceId", "triggeredAt", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + fileName: typing.Union[MetaOapg.properties.fileName, str, ], + exportId: typing.Union[MetaOapg.properties.exportId, str, ], + status: typing.Union[MetaOapg.properties.status, str, ], + errorMessage: typing.Union[MetaOapg.properties.errorMessage, str, schemas.Unset] = schemas.unset, + expiresAt: typing.Union[MetaOapg.properties.expiresAt, str, datetime, schemas.Unset] = schemas.unset, + fileSize: typing.Union[MetaOapg.properties.fileSize, decimal.Decimal, int, schemas.Unset] = schemas.unset, + fileUri: typing.Union[MetaOapg.properties.fileUri, str, schemas.Unset] = schemas.unset, + traceId: typing.Union[MetaOapg.properties.traceId, str, schemas.Unset] = schemas.unset, + triggeredAt: typing.Union[MetaOapg.properties.triggeredAt, str, datetime, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ExportResult': + return super().__new__( + cls, + *_args, + fileName=fileName, + exportId=exportId, + status=status, + errorMessage=errorMessage, + expiresAt=expiresAt, + fileSize=fileSize, + fileUri=fileUri, + traceId=traceId, + triggeredAt=triggeredAt, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/fact_identifier.pyi b/gooddata-api-client/gooddata_api_client/model/fact_identifier.pyi new file mode 100644 index 000000000..a22693986 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/fact_identifier.pyi @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class FactIdentifier( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A fact identifier. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def FACT(cls): + return cls("fact") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'FactIdentifier': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) 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 5592073f4..08cd7970c 100644 --- a/gooddata-api-client/gooddata_api_client/model/failed_operation.py +++ b/gooddata-api-client/gooddata_api_client/model/failed_operation.py @@ -31,18 +31,12 @@ def lazy_import(): - from gooddata_api_client.model.failed_operation import FailedOperation from gooddata_api_client.model.failed_operation_all_of import FailedOperationAllOf from gooddata_api_client.model.operation import Operation from gooddata_api_client.model.operation_error import OperationError - from gooddata_api_client.model.pending_operation import PendingOperation - from gooddata_api_client.model.succeeded_operation import SucceededOperation - globals()['FailedOperation'] = FailedOperation globals()['FailedOperationAllOf'] = FailedOperationAllOf globals()['Operation'] = Operation globals()['OperationError'] = OperationError - globals()['PendingOperation'] = PendingOperation - globals()['SucceededOperation'] = SucceededOperation class FailedOperation(ModelComposed): @@ -73,6 +67,7 @@ class FailedOperation(ModelComposed): ('kind',): { 'PROVISION-DATABASE': "provision-database", 'DEPROVISION-DATABASE': "deprovision-database", + 'RUN-SERVICE-COMMAND': "run-service-command", }, } @@ -110,11 +105,7 @@ def openapi_types(): @cached_property def discriminator(): - lazy_import() val = { - 'failed': FailedOperation, - 'pending': PendingOperation, - 'succeeded': SucceededOperation, } if not val: return None @@ -138,7 +129,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Keyword Args: 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. + 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. status (str): _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be @@ -245,7 +236,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Keyword Args: 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. + 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. status (str): _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be diff --git a/gooddata-api-client/gooddata_api_client/model/failed_operation.pyi b/gooddata-api-client/gooddata_api_client/model/failed_operation.pyi new file mode 100644 index 000000000..75e61ddf4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/failed_operation.pyi @@ -0,0 +1,147 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class FailedOperation( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Operation that has failed + """ + + + class MetaOapg: + required = { + "kind", + "id", + "error", + } + + @staticmethod + def discriminator(): + return { + 'status': { + 'failed': FailedOperation, + 'pending': PendingOperation, + 'succeeded': SucceededOperation, + } + } + + + class all_of_1( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def error() -> typing.Type['OperationError']: + return OperationError + __annotations__ = { + "error": error, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["error"]) -> 'OperationError': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["error", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["error"]) -> typing.Union['OperationError', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["error", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + error: typing.Union['OperationError', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + error=error, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + Operation, + cls.all_of_1, + ] + + + kind: schemas.AnyTypeSchema + id: schemas.AnyTypeSchema + error: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'FailedOperation': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.failed_operation import FailedOperation +from gooddata_api_client.model.operation import Operation +from gooddata_api_client.model.operation_error import OperationError +from gooddata_api_client.model.pending_operation import PendingOperation +from gooddata_api_client.model.succeeded_operation import SucceededOperation diff --git a/gooddata-api-client/gooddata_api_client/model/file.pyi b/gooddata-api-client/gooddata_api_client/model/file.pyi new file mode 100644 index 000000000..e7c024e8f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/file.pyi @@ -0,0 +1,330 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class File( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + + class any( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.DictSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'any': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class canResegment( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def YES(cls): + return cls("YES") + + @schemas.classproperty + def NO(cls): + return cls("NO") + id = schemas.StrSchema + + @staticmethod + def notes() -> typing.Type['Notes']: + return Notes + original = schemas.StrSchema + + + class otherAttributes( + schemas.DictSchema + ): + + + class MetaOapg: + additional_properties = schemas.StrSchema + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, str, ], + ) -> 'otherAttributes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @staticmethod + def skeleton() -> typing.Type['Skeleton']: + return Skeleton + space = schemas.StrSchema + + + class srcDir( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def LTR(cls): + return cls("LTR") + + @schemas.classproperty + def RTL(cls): + return cls("RTL") + + @schemas.classproperty + def AUTO(cls): + return cls("AUTO") + + + class translate( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def YES(cls): + return cls("YES") + + @schemas.classproperty + def NO(cls): + return cls("NO") + + + class trgDir( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def LTR(cls): + return cls("LTR") + + @schemas.classproperty + def RTL(cls): + return cls("RTL") + + @schemas.classproperty + def AUTO(cls): + return cls("AUTO") + + + class unitOrGroup( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.DictSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'unitOrGroup': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "any": any, + "canResegment": canResegment, + "id": id, + "notes": notes, + "original": original, + "otherAttributes": otherAttributes, + "skeleton": skeleton, + "space": space, + "srcDir": srcDir, + "translate": translate, + "trgDir": trgDir, + "unitOrGroup": unitOrGroup, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["any"]) -> MetaOapg.properties.any: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["canResegment"]) -> MetaOapg.properties.canResegment: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["notes"]) -> 'Notes': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["original"]) -> MetaOapg.properties.original: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["otherAttributes"]) -> MetaOapg.properties.otherAttributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["skeleton"]) -> 'Skeleton': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["space"]) -> MetaOapg.properties.space: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["srcDir"]) -> MetaOapg.properties.srcDir: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["translate"]) -> MetaOapg.properties.translate: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["trgDir"]) -> MetaOapg.properties.trgDir: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["unitOrGroup"]) -> MetaOapg.properties.unitOrGroup: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["any", "canResegment", "id", "notes", "original", "otherAttributes", "skeleton", "space", "srcDir", "translate", "trgDir", "unitOrGroup", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["any"]) -> typing.Union[MetaOapg.properties.any, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["canResegment"]) -> typing.Union[MetaOapg.properties.canResegment, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> typing.Union[MetaOapg.properties.id, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["notes"]) -> typing.Union['Notes', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["original"]) -> typing.Union[MetaOapg.properties.original, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["otherAttributes"]) -> typing.Union[MetaOapg.properties.otherAttributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["skeleton"]) -> typing.Union['Skeleton', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["space"]) -> typing.Union[MetaOapg.properties.space, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["srcDir"]) -> typing.Union[MetaOapg.properties.srcDir, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["translate"]) -> typing.Union[MetaOapg.properties.translate, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["trgDir"]) -> typing.Union[MetaOapg.properties.trgDir, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["unitOrGroup"]) -> typing.Union[MetaOapg.properties.unitOrGroup, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["any", "canResegment", "id", "notes", "original", "otherAttributes", "skeleton", "space", "srcDir", "translate", "trgDir", "unitOrGroup", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + any: typing.Union[MetaOapg.properties.any, list, tuple, schemas.Unset] = schemas.unset, + canResegment: typing.Union[MetaOapg.properties.canResegment, str, schemas.Unset] = schemas.unset, + id: typing.Union[MetaOapg.properties.id, str, schemas.Unset] = schemas.unset, + notes: typing.Union['Notes', schemas.Unset] = schemas.unset, + original: typing.Union[MetaOapg.properties.original, str, schemas.Unset] = schemas.unset, + otherAttributes: typing.Union[MetaOapg.properties.otherAttributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + skeleton: typing.Union['Skeleton', schemas.Unset] = schemas.unset, + space: typing.Union[MetaOapg.properties.space, str, schemas.Unset] = schemas.unset, + srcDir: typing.Union[MetaOapg.properties.srcDir, str, schemas.Unset] = schemas.unset, + translate: typing.Union[MetaOapg.properties.translate, str, schemas.Unset] = schemas.unset, + trgDir: typing.Union[MetaOapg.properties.trgDir, str, schemas.Unset] = schemas.unset, + unitOrGroup: typing.Union[MetaOapg.properties.unitOrGroup, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'File': + return super().__new__( + cls, + *_args, + any=any, + canResegment=canResegment, + id=id, + notes=notes, + original=original, + otherAttributes=otherAttributes, + skeleton=skeleton, + space=space, + srcDir=srcDir, + translate=translate, + trgDir=trgDir, + unitOrGroup=unitOrGroup, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.notes import Notes +from gooddata_api_client.model.skeleton import Skeleton diff --git a/gooddata-api-client/gooddata_api_client/model/filter.pyi b/gooddata-api-client/gooddata_api_client/model/filter.pyi new file mode 100644 index 000000000..08abd554a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/filter.pyi @@ -0,0 +1,25 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 +Filter = schemas.DictSchema diff --git a/gooddata-api-client/gooddata_api_client/model/filter_definition.py b/gooddata-api-client/gooddata_api_client/model/filter_definition.py index 7a7d2d65a..9ee434e47 100644 --- a/gooddata-api-client/gooddata_api_client/model/filter_definition.py +++ b/gooddata-api-client/gooddata_api_client/model/filter_definition.py @@ -31,10 +31,10 @@ def lazy_import(): - 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.absolute_date_filter import AbsoluteDateFilter from gooddata_api_client.model.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter + from gooddata_api_client.model.all_time_date_filter import AllTimeDateFilter + from gooddata_api_client.model.all_time_date_filter_all_time_date_filter import AllTimeDateFilterAllTimeDateFilter from gooddata_api_client.model.comparison_measure_value_filter import ComparisonMeasureValueFilter from gooddata_api_client.model.comparison_measure_value_filter_comparison_measure_value_filter import ComparisonMeasureValueFilterComparisonMeasureValueFilter from gooddata_api_client.model.compound_measure_value_filter import CompoundMeasureValueFilter @@ -53,10 +53,10 @@ def lazy_import(): from gooddata_api_client.model.ranking_filter_ranking_filter import RankingFilterRankingFilter from gooddata_api_client.model.relative_date_filter import RelativeDateFilter from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter - globals()['AllTimeDateFilter'] = AllTimeDateFilter - globals()['AllTimeDateFilterAllTimeDateFilter'] = AllTimeDateFilterAllTimeDateFilter globals()['AbsoluteDateFilter'] = AbsoluteDateFilter globals()['AbsoluteDateFilterAbsoluteDateFilter'] = AbsoluteDateFilterAbsoluteDateFilter + globals()['AllTimeDateFilter'] = AllTimeDateFilter + globals()['AllTimeDateFilterAllTimeDateFilter'] = AllTimeDateFilterAllTimeDateFilter globals()['ComparisonMeasureValueFilter'] = ComparisonMeasureValueFilter globals()['ComparisonMeasureValueFilterComparisonMeasureValueFilter'] = ComparisonMeasureValueFilterComparisonMeasureValueFilter globals()['CompoundMeasureValueFilter'] = CompoundMeasureValueFilter @@ -136,8 +136,8 @@ def openapi_types(): 'range_measure_value_filter': (RangeMeasureValueFilterRangeMeasureValueFilter,), # noqa: E501 'compound_measure_value_filter': (CompoundMeasureValueFilterCompoundMeasureValueFilter,), # noqa: E501 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 - 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 + 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 'negative_attribute_filter': (NegativeAttributeFilterNegativeAttributeFilter,), # noqa: E501 'positive_attribute_filter': (PositiveAttributeFilterPositiveAttributeFilter,), # noqa: E501 'match_attribute_filter': (MatchAttributeFilterMatchAttributeFilter,), # noqa: E501 @@ -155,8 +155,8 @@ def discriminator(): 'range_measure_value_filter': 'rangeMeasureValueFilter', # noqa: E501 'compound_measure_value_filter': 'compoundMeasureValueFilter', # noqa: E501 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 - 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 'relative_date_filter': 'relativeDateFilter', # noqa: E501 + 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 'negative_attribute_filter': 'negativeAttributeFilter', # noqa: E501 'positive_attribute_filter': 'positiveAttributeFilter', # noqa: E501 'match_attribute_filter': 'matchAttributeFilter', # noqa: E501 @@ -208,6 +208,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 compound_measure_value_filter (CompoundMeasureValueFilterCompoundMeasureValueFilter): [optional] # noqa: E501 absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 + all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 match_attribute_filter (MatchAttributeFilterMatchAttributeFilter): [optional] # noqa: E501 @@ -321,6 +322,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 compound_measure_value_filter (CompoundMeasureValueFilterCompoundMeasureValueFilter): [optional] # noqa: E501 absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 + all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 match_attribute_filter (MatchAttributeFilterMatchAttributeFilter): [optional] # noqa: E501 @@ -395,8 +397,8 @@ def _composed_schemas(): 'allOf': [ ], 'oneOf': [ - AllTimeDateFilter, AbsoluteDateFilter, + AllTimeDateFilter, ComparisonMeasureValueFilter, CompoundMeasureValueFilter, InlineFilterDefinition, diff --git a/gooddata-api-client/gooddata_api_client/model/filter_definition_for_simple_measure.py b/gooddata-api-client/gooddata_api_client/model/filter_definition_for_simple_measure.py index 51b82755d..a19bd8c5a 100644 --- a/gooddata-api-client/gooddata_api_client/model/filter_definition_for_simple_measure.py +++ b/gooddata-api-client/gooddata_api_client/model/filter_definition_for_simple_measure.py @@ -32,6 +32,7 @@ def lazy_import(): from gooddata_api_client.model.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter + from gooddata_api_client.model.all_time_date_filter_all_time_date_filter import AllTimeDateFilterAllTimeDateFilter from gooddata_api_client.model.attribute_filter import AttributeFilter from gooddata_api_client.model.date_filter import DateFilter from gooddata_api_client.model.match_attribute_filter_match_attribute_filter import MatchAttributeFilterMatchAttributeFilter @@ -39,6 +40,7 @@ def lazy_import(): from gooddata_api_client.model.positive_attribute_filter_positive_attribute_filter import PositiveAttributeFilterPositiveAttributeFilter from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter globals()['AbsoluteDateFilterAbsoluteDateFilter'] = AbsoluteDateFilterAbsoluteDateFilter + globals()['AllTimeDateFilterAllTimeDateFilter'] = AllTimeDateFilterAllTimeDateFilter globals()['AttributeFilter'] = AttributeFilter globals()['DateFilter'] = DateFilter globals()['MatchAttributeFilterMatchAttributeFilter'] = MatchAttributeFilterMatchAttributeFilter @@ -102,6 +104,7 @@ def openapi_types(): return { 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 + 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 'negative_attribute_filter': (NegativeAttributeFilterNegativeAttributeFilter,), # noqa: E501 'positive_attribute_filter': (PositiveAttributeFilterPositiveAttributeFilter,), # noqa: E501 'match_attribute_filter': (MatchAttributeFilterMatchAttributeFilter,), # noqa: E501 @@ -115,6 +118,7 @@ def discriminator(): attribute_map = { 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 'relative_date_filter': 'relativeDateFilter', # noqa: E501 + 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 'negative_attribute_filter': 'negativeAttributeFilter', # noqa: E501 'positive_attribute_filter': 'positiveAttributeFilter', # noqa: E501 'match_attribute_filter': 'matchAttributeFilter', # noqa: E501 @@ -161,6 +165,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 + all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 match_attribute_filter (MatchAttributeFilterMatchAttributeFilter): [optional] # noqa: E501 @@ -269,6 +274,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 + all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 match_attribute_filter (MatchAttributeFilterMatchAttributeFilter): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/forecast_config.py b/gooddata-api-client/gooddata_api_client/model/forecast_config.py new file mode 100644 index 000000000..eeabd896f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/forecast_config.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 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/forecast_config.pyi b/gooddata-api-client/gooddata_api_client/model/forecast_config.pyi new file mode 100644 index 000000000..3dd683371 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/forecast_config.pyi @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ForecastConfig( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Forecast configuration. + """ + + + class MetaOapg: + required = { + "confidenceLevel", + "seasonal", + "forecastPeriod", + } + + class properties: + confidenceLevel = schemas.Float32Schema + forecastPeriod = schemas.Int32Schema + seasonal = schemas.BoolSchema + __annotations__ = { + "confidenceLevel": confidenceLevel, + "forecastPeriod": forecastPeriod, + "seasonal": seasonal, + } + + confidenceLevel: MetaOapg.properties.confidenceLevel + seasonal: MetaOapg.properties.seasonal + forecastPeriod: MetaOapg.properties.forecastPeriod + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["confidenceLevel"]) -> MetaOapg.properties.confidenceLevel: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["forecastPeriod"]) -> MetaOapg.properties.forecastPeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["seasonal"]) -> MetaOapg.properties.seasonal: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["confidenceLevel", "forecastPeriod", "seasonal", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["confidenceLevel"]) -> MetaOapg.properties.confidenceLevel: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["forecastPeriod"]) -> MetaOapg.properties.forecastPeriod: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["seasonal"]) -> MetaOapg.properties.seasonal: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["confidenceLevel", "forecastPeriod", "seasonal", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + confidenceLevel: typing.Union[MetaOapg.properties.confidenceLevel, decimal.Decimal, int, float, ], + seasonal: typing.Union[MetaOapg.properties.seasonal, bool, ], + forecastPeriod: typing.Union[MetaOapg.properties.forecastPeriod, decimal.Decimal, int, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ForecastConfig': + return super().__new__( + cls, + *_args, + confidenceLevel=confidenceLevel, + seasonal=seasonal, + forecastPeriod=forecastPeriod, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/forecast_request.pyi b/gooddata-api-client/gooddata_api_client/model/forecast_request.pyi new file mode 100644 index 000000000..e3356c4fb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/forecast_request.pyi @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ForecastRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "forecastPeriod", + } + + class properties: + forecastPeriod = schemas.Int32Schema + + + class confidenceLevel( + schemas.Float32Schema + ): + pass + seasonal = schemas.BoolSchema + __annotations__ = { + "forecastPeriod": forecastPeriod, + "confidenceLevel": confidenceLevel, + "seasonal": seasonal, + } + + forecastPeriod: MetaOapg.properties.forecastPeriod + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["forecastPeriod"]) -> MetaOapg.properties.forecastPeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["confidenceLevel"]) -> MetaOapg.properties.confidenceLevel: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["seasonal"]) -> MetaOapg.properties.seasonal: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["forecastPeriod", "confidenceLevel", "seasonal", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["forecastPeriod"]) -> MetaOapg.properties.forecastPeriod: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["confidenceLevel"]) -> typing.Union[MetaOapg.properties.confidenceLevel, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["seasonal"]) -> typing.Union[MetaOapg.properties.seasonal, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["forecastPeriod", "confidenceLevel", "seasonal", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + forecastPeriod: typing.Union[MetaOapg.properties.forecastPeriod, decimal.Decimal, int, ], + confidenceLevel: typing.Union[MetaOapg.properties.confidenceLevel, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + seasonal: typing.Union[MetaOapg.properties.seasonal, bool, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ForecastRequest': + return super().__new__( + cls, + *_args, + forecastPeriod=forecastPeriod, + confidenceLevel=confidenceLevel, + seasonal=seasonal, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/forecast_result.pyi b/gooddata-api-client/gooddata_api_client/model/forecast_result.pyi new file mode 100644 index 000000000..fc4ab290f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/forecast_result.pyi @@ -0,0 +1,318 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ForecastResult( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "upperBound", + "origin", + "prediction", + "lowerBound", + "attribute", + } + + class properties: + + + class attribute( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attribute': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class lowerBound( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.NumberBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneDecimalMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, decimal.Decimal, int, float, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, None, decimal.Decimal, int, float, ]], typing.List[typing.Union[MetaOapg.items, None, decimal.Decimal, int, float, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'lowerBound': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class origin( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.NumberBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneDecimalMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, decimal.Decimal, int, float, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, None, decimal.Decimal, int, float, ]], typing.List[typing.Union[MetaOapg.items, None, decimal.Decimal, int, float, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'origin': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class prediction( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.NumberBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneDecimalMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, decimal.Decimal, int, float, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, None, decimal.Decimal, int, float, ]], typing.List[typing.Union[MetaOapg.items, None, decimal.Decimal, int, float, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'prediction': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class upperBound( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.NumberBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneDecimalMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, decimal.Decimal, int, float, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, None, decimal.Decimal, int, float, ]], typing.List[typing.Union[MetaOapg.items, None, decimal.Decimal, int, float, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'upperBound': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "attribute": attribute, + "lowerBound": lowerBound, + "origin": origin, + "prediction": prediction, + "upperBound": upperBound, + } + + upperBound: MetaOapg.properties.upperBound + origin: MetaOapg.properties.origin + prediction: MetaOapg.properties.prediction + lowerBound: MetaOapg.properties.lowerBound + attribute: MetaOapg.properties.attribute + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attribute"]) -> MetaOapg.properties.attribute: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["lowerBound"]) -> MetaOapg.properties.lowerBound: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["origin"]) -> MetaOapg.properties.origin: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["prediction"]) -> MetaOapg.properties.prediction: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["upperBound"]) -> MetaOapg.properties.upperBound: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attribute", "lowerBound", "origin", "prediction", "upperBound", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attribute"]) -> MetaOapg.properties.attribute: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["lowerBound"]) -> MetaOapg.properties.lowerBound: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["origin"]) -> MetaOapg.properties.origin: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["prediction"]) -> MetaOapg.properties.prediction: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["upperBound"]) -> MetaOapg.properties.upperBound: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attribute", "lowerBound", "origin", "prediction", "upperBound", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + upperBound: typing.Union[MetaOapg.properties.upperBound, list, tuple, ], + origin: typing.Union[MetaOapg.properties.origin, list, tuple, ], + prediction: typing.Union[MetaOapg.properties.prediction, list, tuple, ], + lowerBound: typing.Union[MetaOapg.properties.lowerBound, list, tuple, ], + attribute: typing.Union[MetaOapg.properties.attribute, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ForecastResult': + return super().__new__( + cls, + *_args, + upperBound=upperBound, + origin=origin, + prediction=prediction, + lowerBound=lowerBound, + attribute=attribute, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/found_objects.pyi b/gooddata-api-client/gooddata_api_client/model/found_objects.pyi new file mode 100644 index 000000000..ebe66cd1d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/found_objects.pyi @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class FoundObjects( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + List of objects found by similarity search and post-processed by LLM. + """ + + + class MetaOapg: + required = { + "objects", + "reasoning", + } + + class properties: + + + class objects( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['SearchResultObject']: + return SearchResultObject + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['SearchResultObject'], typing.List['SearchResultObject']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'objects': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'SearchResultObject': + return super().__getitem__(i) + reasoning = schemas.StrSchema + __annotations__ = { + "objects": objects, + "reasoning": reasoning, + } + + objects: MetaOapg.properties.objects + reasoning: MetaOapg.properties.reasoning + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["objects"]) -> MetaOapg.properties.objects: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["reasoning"]) -> MetaOapg.properties.reasoning: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["objects", "reasoning", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["objects"]) -> MetaOapg.properties.objects: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["reasoning"]) -> MetaOapg.properties.reasoning: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["objects", "reasoning", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + objects: typing.Union[MetaOapg.properties.objects, list, tuple, ], + reasoning: typing.Union[MetaOapg.properties.reasoning, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'FoundObjects': + return super().__new__( + cls, + *_args, + objects=objects, + reasoning=reasoning, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.search_result_object import SearchResultObject diff --git a/gooddata-api-client/gooddata_api_client/model/frequency.pyi b/gooddata-api-client/gooddata_api_client/model/frequency.pyi new file mode 100644 index 000000000..ee81ca621 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/frequency.pyi @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Frequency( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "buckets", + } + + class properties: + + + class buckets( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['FrequencyBucket']: + return FrequencyBucket + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['FrequencyBucket'], typing.List['FrequencyBucket']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'buckets': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'FrequencyBucket': + return super().__getitem__(i) + __annotations__ = { + "buckets": buckets, + } + + buckets: MetaOapg.properties.buckets + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["buckets"]) -> MetaOapg.properties.buckets: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["buckets", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["buckets"]) -> MetaOapg.properties.buckets: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["buckets", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + buckets: typing.Union[MetaOapg.properties.buckets, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Frequency': + return super().__new__( + cls, + *_args, + buckets=buckets, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.frequency_bucket import FrequencyBucket diff --git a/gooddata-api-client/gooddata_api_client/model/frequency_bucket.pyi b/gooddata-api-client/gooddata_api_client/model/frequency_bucket.pyi new file mode 100644 index 000000000..53694450a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/frequency_bucket.pyi @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class FrequencyBucket( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "count", + } + + class properties: + count = schemas.Int64Schema + value = schemas.StrSchema + __annotations__ = { + "count": count, + "value": value, + } + + count: MetaOapg.properties.count + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["count"]) -> MetaOapg.properties.count: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["count", "value", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["count"]) -> MetaOapg.properties.count: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["value"]) -> typing.Union[MetaOapg.properties.value, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["count", "value", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + count: typing.Union[MetaOapg.properties.count, decimal.Decimal, int, ], + value: typing.Union[MetaOapg.properties.value, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'FrequencyBucket': + return super().__new__( + cls, + *_args, + count=count, + value=value, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/frequency_properties.pyi b/gooddata-api-client/gooddata_api_client/model/frequency_properties.pyi new file mode 100644 index 000000000..a71418868 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/frequency_properties.pyi @@ -0,0 +1,79 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class FrequencyProperties( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + valueLimit = schemas.Int32Schema + __annotations__ = { + "valueLimit": valueLimit, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["valueLimit"]) -> MetaOapg.properties.valueLimit: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["valueLimit", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["valueLimit"]) -> typing.Union[MetaOapg.properties.valueLimit, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["valueLimit", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + valueLimit: typing.Union[MetaOapg.properties.valueLimit, decimal.Decimal, int, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'FrequencyProperties': + return super().__new__( + cls, + *_args, + valueLimit=valueLimit, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/generate_description_request.py b/gooddata-api-client/gooddata_api_client/model/generate_description_request.py new file mode 100644 index 000000000..7c8d5ff40 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/generate_description_request.py @@ -0,0 +1,283 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class GenerateDescriptionRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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_type',): { + 'VISUALIZATION': "Visualization", + 'DASHBOARD': "Dashboard", + 'METRIC': "Metric", + 'FACT': "Fact", + 'ATTRIBUTE': "Attribute", + }, + } + + 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 { + 'object_id': (str,), # noqa: E501 + 'object_type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'object_id': 'objectId', # noqa: E501 + 'object_type': 'objectType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, object_id, object_type, *args, **kwargs): # noqa: E501 + """GenerateDescriptionRequest - a model defined in OpenAPI + + Args: + object_id (str): Identifier of the object to describe + object_type (str): Type of the object to describe. One of: visualization, dashboard, metric, fact, 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,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.object_id = object_id + self.object_type = object_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, object_id, object_type, *args, **kwargs): # noqa: E501 + """GenerateDescriptionRequest - a model defined in OpenAPI + + Args: + object_id (str): Identifier of the object to describe + object_type (str): Type of the object to describe. One of: visualization, dashboard, metric, fact, 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,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.object_id = object_id + self.object_type = object_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/generate_description_request.pyi b/gooddata-api-client/gooddata_api_client/model/generate_description_request.pyi new file mode 100644 index 000000000..5481f741c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/generate_description_request.pyi @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class GenerateDescriptionRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "objectId", + "objectType", + } + + class properties: + objectId = schemas.StrSchema + + + class objectType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def VISUALIZATION(cls): + return cls("Visualization") + + @schemas.classproperty + def DASHBOARD(cls): + return cls("Dashboard") + + @schemas.classproperty + def METRIC(cls): + return cls("Metric") + + @schemas.classproperty + def FACT(cls): + return cls("Fact") + + @schemas.classproperty + def ATTRIBUTE(cls): + return cls("Attribute") + __annotations__ = { + "objectId": objectId, + "objectType": objectType, + } + + objectId: MetaOapg.properties.objectId + objectType: MetaOapg.properties.objectType + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["objectId"]) -> MetaOapg.properties.objectId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["objectType"]) -> MetaOapg.properties.objectType: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["objectId", "objectType", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["objectId"]) -> MetaOapg.properties.objectId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["objectType"]) -> MetaOapg.properties.objectType: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["objectId", "objectType", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + objectId: typing.Union[MetaOapg.properties.objectId, str, ], + objectType: typing.Union[MetaOapg.properties.objectType, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'GenerateDescriptionRequest': + return super().__new__( + cls, + *_args, + objectId=objectId, + objectType=objectType, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/generate_description_response.py b/gooddata-api-client/gooddata_api_client/model/generate_description_response.py new file mode 100644 index 000000000..2fd35a957 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/generate_description_response.py @@ -0,0 +1,268 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class GenerateDescriptionResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'description': (str,), # noqa: E501 + 'note': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'description': 'description', # noqa: E501 + 'note': 'note', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """GenerateDescriptionResponse - 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): Generated description of the requested object. [optional] # noqa: E501 + note (str): Additional note with details in case generation was not performed. [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 + """GenerateDescriptionResponse - 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): Generated description of the requested object. [optional] # noqa: E501 + note (str): Additional note with details in case generation was not performed. [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/generate_description_response.pyi b/gooddata-api-client/gooddata_api_client/model/generate_description_response.pyi new file mode 100644 index 000000000..d2bd21d98 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/generate_description_response.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class GenerateDescriptionResponse( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + description = schemas.StrSchema + note = schemas.StrSchema + __annotations__ = { + "description": description, + "note": note, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["note"]) -> MetaOapg.properties.note: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["description", "note", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["note"]) -> typing.Union[MetaOapg.properties.note, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["description", "note", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + note: typing.Union[MetaOapg.properties.note, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'GenerateDescriptionResponse': + return super().__new__( + cls, + *_args, + description=description, + note=note, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/generate_title_request.py b/gooddata-api-client/gooddata_api_client/model/generate_title_request.py new file mode 100644 index 000000000..26ca56867 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/generate_title_request.py @@ -0,0 +1,283 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class GenerateTitleRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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_type',): { + 'VISUALIZATION': "Visualization", + 'DASHBOARD': "Dashboard", + 'METRIC': "Metric", + 'FACT': "Fact", + 'ATTRIBUTE': "Attribute", + }, + } + + 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 { + 'object_id': (str,), # noqa: E501 + 'object_type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'object_id': 'objectId', # noqa: E501 + 'object_type': 'objectType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, object_id, object_type, *args, **kwargs): # noqa: E501 + """GenerateTitleRequest - a model defined in OpenAPI + + Args: + object_id (str): Identifier of the object to title + object_type (str): Type of the object to title. Matches chat-search object types. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.object_id = object_id + self.object_type = object_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, object_id, object_type, *args, **kwargs): # noqa: E501 + """GenerateTitleRequest - a model defined in OpenAPI + + Args: + object_id (str): Identifier of the object to title + object_type (str): Type of the object to title. Matches chat-search object types. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.object_id = object_id + self.object_type = object_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/generate_title_request.pyi b/gooddata-api-client/gooddata_api_client/model/generate_title_request.pyi new file mode 100644 index 000000000..3266c243d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/generate_title_request.pyi @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class GenerateTitleRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "objectId", + "objectType", + } + + class properties: + objectId = schemas.StrSchema + + + class objectType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def VISUALIZATION(cls): + return cls("Visualization") + + @schemas.classproperty + def DASHBOARD(cls): + return cls("Dashboard") + + @schemas.classproperty + def METRIC(cls): + return cls("Metric") + + @schemas.classproperty + def FACT(cls): + return cls("Fact") + + @schemas.classproperty + def ATTRIBUTE(cls): + return cls("Attribute") + __annotations__ = { + "objectId": objectId, + "objectType": objectType, + } + + objectId: MetaOapg.properties.objectId + objectType: MetaOapg.properties.objectType + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["objectId"]) -> MetaOapg.properties.objectId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["objectType"]) -> MetaOapg.properties.objectType: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["objectId", "objectType", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["objectId"]) -> MetaOapg.properties.objectId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["objectType"]) -> MetaOapg.properties.objectType: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["objectId", "objectType", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + objectId: typing.Union[MetaOapg.properties.objectId, str, ], + objectType: typing.Union[MetaOapg.properties.objectType, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'GenerateTitleRequest': + return super().__new__( + cls, + *_args, + objectId=objectId, + objectType=objectType, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/generate_title_response.py b/gooddata-api-client/gooddata_api_client/model/generate_title_response.py new file mode 100644 index 000000000..d0e07e4f3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/generate_title_response.py @@ -0,0 +1,268 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class GenerateTitleResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'note': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'note': 'note', # 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 + """GenerateTitleResponse - 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,) + note (str): Additional note with details in case generation was not performed. [optional] # noqa: E501 + title (str): Generated title of the requested object. [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 + """GenerateTitleResponse - 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,) + note (str): Additional note with details in case generation was not performed. [optional] # noqa: E501 + title (str): Generated title of the requested object. [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/generate_title_response.pyi b/gooddata-api-client/gooddata_api_client/model/generate_title_response.pyi new file mode 100644 index 000000000..06e7eaa6e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/generate_title_response.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class GenerateTitleResponse( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + note = schemas.StrSchema + title = schemas.StrSchema + __annotations__ = { + "note": note, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["note"]) -> MetaOapg.properties.note: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["note", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["note"]) -> typing.Union[MetaOapg.properties.note, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["note", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + note: typing.Union[MetaOapg.properties.note, str, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'GenerateTitleResponse': + return super().__new__( + cls, + *_args, + note=note, + title=title, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/geo_area_config.pyi b/gooddata-api-client/gooddata_api_client/model/geo_area_config.pyi new file mode 100644 index 000000000..0a27b96c5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/geo_area_config.pyi @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class GeoAreaConfig( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Configuration specific to geo area labels. + """ + + + class MetaOapg: + required = { + "collection", + } + + class properties: + + @staticmethod + def collection() -> typing.Type['GeoCollectionIdentifier']: + return GeoCollectionIdentifier + __annotations__ = { + "collection": collection, + } + + collection: 'GeoCollectionIdentifier' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["collection"]) -> 'GeoCollectionIdentifier': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["collection", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["collection"]) -> 'GeoCollectionIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["collection", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + collection: 'GeoCollectionIdentifier', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'GeoAreaConfig': + return super().__new__( + cls, + *_args, + collection=collection, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.geo_collection_identifier import GeoCollectionIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/geo_collection_identifier.pyi b/gooddata-api-client/gooddata_api_client/model/geo_collection_identifier.pyi new file mode 100644 index 000000000..4028b9969 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/geo_collection_identifier.pyi @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class GeoCollectionIdentifier( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "id", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class kind( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def STATIC(cls): + return cls("STATIC") + + @schemas.classproperty + def CUSTOM(cls): + return cls("CUSTOM") + __annotations__ = { + "id": id, + "kind": kind, + } + + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["kind"]) -> MetaOapg.properties.kind: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "kind", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["kind"]) -> typing.Union[MetaOapg.properties.kind, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "kind", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + kind: typing.Union[MetaOapg.properties.kind, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'GeoCollectionIdentifier': + return super().__new__( + cls, + *_args, + id=id, + kind=kind, + _configuration=_configuration, + **kwargs, + ) 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 dafad0e18..33f767cba 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 @@ -69,6 +69,7 @@ class GetAiLakeOperation200Response(ModelComposed): ('kind',): { 'PROVISION-DATABASE': "provision-database", 'DEPROVISION-DATABASE': "deprovision-database", + 'RUN-SERVICE-COMMAND': "run-service-command", }, } @@ -170,7 +171,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. . [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. . [optional] # noqa: E501 error (OperationError): [optional] # noqa: E501 """ @@ -278,7 +279,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. . [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. . [optional] # noqa: E501 error (OperationError): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/get_quality_issues_response.py b/gooddata-api-client/gooddata_api_client/model/get_quality_issues_response.py index 7bc13619b..e719a597a 100644 --- a/gooddata-api-client/gooddata_api_client/model/get_quality_issues_response.py +++ b/gooddata-api-client/gooddata_api_client/model/get_quality_issues_response.py @@ -65,6 +65,7 @@ class GetQualityIssuesResponse(ModelNormal): 'SYNCING': "SYNCING", 'COMPLETED': "COMPLETED", 'FAILED': "FAILED", + 'CANCELLED': "CANCELLED", 'NOT_FOUND': "NOT_FOUND", 'DISABLED': "DISABLED", }, diff --git a/gooddata-api-client/gooddata_api_client/model/get_quality_issues_response.pyi b/gooddata-api-client/gooddata_api_client/model/get_quality_issues_response.pyi new file mode 100644 index 000000000..722aa4b7c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/get_quality_issues_response.pyi @@ -0,0 +1,166 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class GetQualityIssuesResponse( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "issues", + "status", + } + + class properties: + + + class issues( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['QualityIssue']: + return QualityIssue + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['QualityIssue'], typing.List['QualityIssue']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'issues': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'QualityIssue': + return super().__getitem__(i) + + + class status( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def RUNNING(cls): + return cls("RUNNING") + + @schemas.classproperty + def SYNCING(cls): + return cls("SYNCING") + + @schemas.classproperty + def COMPLETED(cls): + return cls("COMPLETED") + + @schemas.classproperty + def FAILED(cls): + return cls("FAILED") + + @schemas.classproperty + def CANCELLED(cls): + return cls("CANCELLED") + + @schemas.classproperty + def NOT_FOUND(cls): + return cls("NOT_FOUND") + + @schemas.classproperty + def DISABLED(cls): + return cls("DISABLED") + updatedAt = schemas.StrSchema + __annotations__ = { + "issues": issues, + "status": status, + "updatedAt": updatedAt, + } + + issues: MetaOapg.properties.issues + status: MetaOapg.properties.status + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["issues"]) -> MetaOapg.properties.issues: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["updatedAt"]) -> MetaOapg.properties.updatedAt: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["issues", "status", "updatedAt", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["issues"]) -> MetaOapg.properties.issues: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["updatedAt"]) -> typing.Union[MetaOapg.properties.updatedAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["issues", "status", "updatedAt", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + issues: typing.Union[MetaOapg.properties.issues, list, tuple, ], + status: typing.Union[MetaOapg.properties.status, str, ], + updatedAt: typing.Union[MetaOapg.properties.updatedAt, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'GetQualityIssuesResponse': + return super().__new__( + cls, + *_args, + issues=issues, + status=status, + updatedAt=updatedAt, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.quality_issue import QualityIssue diff --git a/gooddata-api-client/gooddata_api_client/model/histogram.pyi b/gooddata-api-client/gooddata_api_client/model/histogram.pyi new file mode 100644 index 000000000..fc1609e3c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/histogram.pyi @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Histogram( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "buckets", + } + + class properties: + + + class buckets( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['HistogramBucket']: + return HistogramBucket + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['HistogramBucket'], typing.List['HistogramBucket']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'buckets': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'HistogramBucket': + return super().__getitem__(i) + __annotations__ = { + "buckets": buckets, + } + + buckets: MetaOapg.properties.buckets + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["buckets"]) -> MetaOapg.properties.buckets: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["buckets", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["buckets"]) -> MetaOapg.properties.buckets: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["buckets", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + buckets: typing.Union[MetaOapg.properties.buckets, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Histogram': + return super().__new__( + cls, + *_args, + buckets=buckets, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.histogram_bucket import HistogramBucket diff --git a/gooddata-api-client/gooddata_api_client/model/histogram_bucket.pyi b/gooddata-api-client/gooddata_api_client/model/histogram_bucket.pyi new file mode 100644 index 000000000..bf3c48b2d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/histogram_bucket.pyi @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class HistogramBucket( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "upperBound", + "count", + "lowerBound", + } + + class properties: + count = schemas.Int64Schema + lowerBound = schemas.Float64Schema + upperBound = schemas.Float64Schema + __annotations__ = { + "count": count, + "lowerBound": lowerBound, + "upperBound": upperBound, + } + + upperBound: MetaOapg.properties.upperBound + count: MetaOapg.properties.count + lowerBound: MetaOapg.properties.lowerBound + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["count"]) -> MetaOapg.properties.count: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["lowerBound"]) -> MetaOapg.properties.lowerBound: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["upperBound"]) -> MetaOapg.properties.upperBound: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["count", "lowerBound", "upperBound", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["count"]) -> MetaOapg.properties.count: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["lowerBound"]) -> MetaOapg.properties.lowerBound: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["upperBound"]) -> MetaOapg.properties.upperBound: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["count", "lowerBound", "upperBound", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + upperBound: typing.Union[MetaOapg.properties.upperBound, decimal.Decimal, int, float, ], + count: typing.Union[MetaOapg.properties.count, decimal.Decimal, int, ], + lowerBound: typing.Union[MetaOapg.properties.lowerBound, decimal.Decimal, int, float, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'HistogramBucket': + return super().__new__( + cls, + *_args, + upperBound=upperBound, + count=count, + lowerBound=lowerBound, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/histogram_properties.pyi b/gooddata-api-client/gooddata_api_client/model/histogram_properties.pyi new file mode 100644 index 000000000..c1d1fa09b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/histogram_properties.pyi @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class HistogramProperties( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "bucketCount", + } + + class properties: + bucketCount = schemas.Int32Schema + __annotations__ = { + "bucketCount": bucketCount, + } + + bucketCount: MetaOapg.properties.bucketCount + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["bucketCount"]) -> MetaOapg.properties.bucketCount: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["bucketCount", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["bucketCount"]) -> MetaOapg.properties.bucketCount: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["bucketCount", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + bucketCount: typing.Union[MetaOapg.properties.bucketCount, decimal.Decimal, int, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'HistogramProperties': + return super().__new__( + cls, + *_args, + bucketCount=bucketCount, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/identifier_ref.pyi b/gooddata-api-client/gooddata_api_client/model/identifier_ref.pyi new file mode 100644 index 000000000..7483498a0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/identifier_ref.pyi @@ -0,0 +1,242 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class IdentifierRef( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + + class identifier( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def ATTRIBUTE(cls): + return cls("attribute") + + @schemas.classproperty + def ATTRIBUTE_HIERARCHY(cls): + return cls("attributeHierarchy") + + @schemas.classproperty + def DASHBOARD_PLUGIN(cls): + return cls("dashboardPlugin") + + @schemas.classproperty + def DATASET(cls): + return cls("dataset") + + @schemas.classproperty + def FACT(cls): + return cls("fact") + + @schemas.classproperty + def AGGREGATED_FACT(cls): + return cls("aggregatedFact") + + @schemas.classproperty + def LABEL(cls): + return cls("label") + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def USER_DATA_FILTER(cls): + return cls("userDataFilter") + + @schemas.classproperty + def EXPORT_DEFINITION(cls): + return cls("exportDefinition") + + @schemas.classproperty + def AUTOMATION(cls): + return cls("automation") + + @schemas.classproperty + def AUTOMATION_RESULT(cls): + return cls("automationResult") + + @schemas.classproperty + def MEMORY_ITEM(cls): + return cls("memoryItem") + + @schemas.classproperty + def KNOWLEDGE_RECOMMENDATION(cls): + return cls("knowledgeRecommendation") + + @schemas.classproperty + def PROMPT(cls): + return cls("prompt") + + @schemas.classproperty + def VISUALIZATION_OBJECT(cls): + return cls("visualizationObject") + + @schemas.classproperty + def FILTER_CONTEXT(cls): + return cls("filterContext") + + @schemas.classproperty + def WORKSPACE_SETTINGS(cls): + return cls("workspaceSettings") + + @schemas.classproperty + def CUSTOM_APPLICATION_SETTING(cls): + return cls("customApplicationSetting") + + @schemas.classproperty + def WORKSPACE_DATA_FILTER(cls): + return cls("workspaceDataFilter") + + @schemas.classproperty + def WORKSPACE_DATA_FILTER_SETTING(cls): + return cls("workspaceDataFilterSetting") + + @schemas.classproperty + def FILTER_VIEW(cls): + return cls("filterView") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'identifier': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "identifier": identifier, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["identifier"]) -> MetaOapg.properties.identifier: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["identifier", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["identifier"]) -> typing.Union[MetaOapg.properties.identifier, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["identifier", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + identifier: typing.Union[MetaOapg.properties.identifier, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'IdentifierRef': + return super().__new__( + cls, + *_args, + identifier=identifier, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/image_export_request.pyi b/gooddata-api-client/gooddata_api_client/model/image_export_request.pyi new file mode 100644 index 000000000..94146372a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/image_export_request.pyi @@ -0,0 +1,173 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ImageExportRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Export request object describing the export properties and metadata for image exports. + """ + + + class MetaOapg: + required = { + "fileName", + "dashboardId", + "widgetIds", + "format", + } + + class properties: + dashboardId = schemas.StrSchema + fileName = schemas.StrSchema + + + class format( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PNG(cls): + return cls("PNG") + + + class widgetIds( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.StrSchema + ): + pass + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'widgetIds': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def metadata() -> typing.Type['JsonNode']: + return JsonNode + __annotations__ = { + "dashboardId": dashboardId, + "fileName": fileName, + "format": format, + "widgetIds": widgetIds, + "metadata": metadata, + } + + fileName: MetaOapg.properties.fileName + dashboardId: MetaOapg.properties.dashboardId + widgetIds: MetaOapg.properties.widgetIds + format: MetaOapg.properties.format + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardId"]) -> MetaOapg.properties.dashboardId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetIds"]) -> MetaOapg.properties.widgetIds: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metadata"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dashboardId", "fileName", "format", "widgetIds", "metadata", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardId"]) -> MetaOapg.properties.dashboardId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetIds"]) -> MetaOapg.properties.widgetIds: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metadata"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dashboardId", "fileName", "format", "widgetIds", "metadata", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + fileName: typing.Union[MetaOapg.properties.fileName, str, ], + dashboardId: typing.Union[MetaOapg.properties.dashboardId, str, ], + widgetIds: typing.Union[MetaOapg.properties.widgetIds, list, tuple, ], + format: typing.Union[MetaOapg.properties.format, str, ], + metadata: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ImageExportRequest': + return super().__new__( + cls, + *_args, + fileName=fileName, + dashboardId=dashboardId, + widgetIds=widgetIds, + format=format, + metadata=metadata, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/in_platform.pyi b/gooddata-api-client/gooddata_api_client/model/in_platform.pyi new file mode 100644 index 000000000..11dc83d83 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/in_platform.pyi @@ -0,0 +1,170 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class InPlatform( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + In-platform destination for notifications. + """ + + + class MetaOapg: + required = { + "type", + } + + class properties: + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def IN_PLATFORM(cls): + return cls("IN_PLATFORM") + __annotations__ = { + "type": type, + } + + + class all_of_0( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def IN_PLATFORM(cls): + return cls("IN_PLATFORM") + __annotations__ = { + "type": type, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> typing.Union[MetaOapg.properties.type, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + type=type, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + ] + + + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'InPlatform': + return super().__new__( + cls, + *_args, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/intro_slide_template.pyi b/gooddata-api-client/gooddata_api_client/model/intro_slide_template.pyi new file mode 100644 index 000000000..7d37e9044 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/intro_slide_template.pyi @@ -0,0 +1,171 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class IntroSlideTemplate( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Settings for intro slide. + """ + + + class MetaOapg: + + class properties: + backgroundImage = schemas.BoolSchema + + + class descriptionField( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'descriptionField': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + @staticmethod + def footer() -> typing.Type['RunningSection']: + return RunningSection + + @staticmethod + def header() -> typing.Type['RunningSection']: + return RunningSection + + + class titleField( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'titleField': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + __annotations__ = { + "backgroundImage": backgroundImage, + "descriptionField": descriptionField, + "footer": footer, + "header": header, + "titleField": titleField, + } + + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["backgroundImage"]) -> MetaOapg.properties.backgroundImage: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["descriptionField"]) -> MetaOapg.properties.descriptionField: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["footer"]) -> 'RunningSection': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["header"]) -> 'RunningSection': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["titleField"]) -> MetaOapg.properties.titleField: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["backgroundImage", "descriptionField", "footer", "header", "titleField", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["backgroundImage"]) -> typing.Union[MetaOapg.properties.backgroundImage, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["descriptionField"]) -> typing.Union[MetaOapg.properties.descriptionField, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["footer"]) -> typing.Union['RunningSection', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["header"]) -> typing.Union['RunningSection', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["titleField"]) -> typing.Union[MetaOapg.properties.titleField, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["backgroundImage", "descriptionField", "footer", "header", "titleField", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + backgroundImage: typing.Union[MetaOapg.properties.backgroundImage, bool, schemas.Unset] = schemas.unset, + descriptionField: typing.Union[MetaOapg.properties.descriptionField, None, str, schemas.Unset] = schemas.unset, + footer: typing.Union['RunningSection', schemas.Unset] = schemas.unset, + header: typing.Union['RunningSection', schemas.Unset] = schemas.unset, + titleField: typing.Union[MetaOapg.properties.titleField, None, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'IntroSlideTemplate': + return super().__new__( + cls, + *_args, + backgroundImage=backgroundImage, + descriptionField=descriptionField, + footer=footer, + header=header, + titleField=titleField, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.running_section import RunningSection diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_linkage.pyi new file mode 100644 index 000000000..279f319ba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_linkage.pyi @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAggregatedFactLinkage( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + The \"type\" and \"id\" to non-empty members. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def AGGREGATED_FACT(cls): + return cls("aggregatedFact") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAggregatedFactLinkage': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out.pyi new file mode 100644 index 000000000..e7a714727 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out.pyi @@ -0,0 +1,654 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAggregatedFactOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of aggregatedFact entity. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "operation", + } + + class properties: + areRelationsValid = schemas.BoolSchema + + + class description( + schemas.StrSchema + ): + pass + isNullable = schemas.BoolSchema + nullValue = schemas.StrSchema + + + class operation( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SUM(cls): + return cls("SUM") + + @schemas.classproperty + def MIN(cls): + return cls("MIN") + + @schemas.classproperty + def MAX(cls): + return cls("MAX") + + + class sourceColumn( + schemas.StrSchema + ): + pass + + + class sourceColumnDataType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INT(cls): + return cls("INT") + + @schemas.classproperty + def STRING(cls): + return cls("STRING") + + @schemas.classproperty + def DATE(cls): + return cls("DATE") + + @schemas.classproperty + def NUMERIC(cls): + return cls("NUMERIC") + + @schemas.classproperty + def TIMESTAMP(cls): + return cls("TIMESTAMP") + + @schemas.classproperty + def TIMESTAMP_TZ(cls): + return cls("TIMESTAMP_TZ") + + @schemas.classproperty + def BOOLEAN(cls): + return cls("BOOLEAN") + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "areRelationsValid": areRelationsValid, + "description": description, + "isNullable": isNullable, + "nullValue": nullValue, + "operation": operation, + "sourceColumn": sourceColumn, + "sourceColumnDataType": sourceColumnDataType, + "tags": tags, + } + + operation: MetaOapg.properties.operation + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isNullable"]) -> MetaOapg.properties.isNullable: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["nullValue"]) -> MetaOapg.properties.nullValue: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["operation"]) -> MetaOapg.properties.operation: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sourceColumn"]) -> MetaOapg.properties.sourceColumn: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sourceColumnDataType"]) -> MetaOapg.properties.sourceColumnDataType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "isNullable", "nullValue", "operation", "sourceColumn", "sourceColumnDataType", "tags", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isNullable"]) -> typing.Union[MetaOapg.properties.isNullable, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["nullValue"]) -> typing.Union[MetaOapg.properties.nullValue, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["operation"]) -> MetaOapg.properties.operation: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sourceColumn"]) -> typing.Union[MetaOapg.properties.sourceColumn, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sourceColumnDataType"]) -> typing.Union[MetaOapg.properties.sourceColumnDataType, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "isNullable", "nullValue", "operation", "sourceColumn", "sourceColumnDataType", "tags", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + operation: typing.Union[MetaOapg.properties.operation, str, ], + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + isNullable: typing.Union[MetaOapg.properties.isNullable, bool, schemas.Unset] = schemas.unset, + nullValue: typing.Union[MetaOapg.properties.nullValue, str, schemas.Unset] = schemas.unset, + sourceColumn: typing.Union[MetaOapg.properties.sourceColumn, str, schemas.Unset] = schemas.unset, + sourceColumnDataType: typing.Union[MetaOapg.properties.sourceColumnDataType, str, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + operation=operation, + areRelationsValid=areRelationsValid, + description=description, + isNullable=isNullable, + nullValue=nullValue, + sourceColumn=sourceColumn, + sourceColumnDataType=sourceColumnDataType, + tags=tags, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def AGGREGATED_FACT(cls): + return cls("aggregatedFact") + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class origin( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "originType", + "originId", + } + + class properties: + originId = schemas.StrSchema + + + class originType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") + + @schemas.classproperty + def PARENT(cls): + return cls("PARENT") + __annotations__ = { + "originId": originId, + "originType": originType, + } + + originType: MetaOapg.properties.originType + originId: MetaOapg.properties.originId + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + originType: typing.Union[MetaOapg.properties.originType, str, ], + originId: typing.Union[MetaOapg.properties.originId, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'origin': + return super().__new__( + cls, + *_args, + originType=originType, + originId=originId, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "origin": origin, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["origin"]) -> MetaOapg.properties.origin: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["origin"]) -> typing.Union[MetaOapg.properties.origin, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + origin: typing.Union[MetaOapg.properties.origin, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + origin=origin, + _configuration=_configuration, + **kwargs, + ) + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class dataset( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiDatasetToOneLinkage']: + return JsonApiDatasetToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiDatasetToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiDatasetToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'dataset': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class sourceFact( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiFactToOneLinkage']: + return JsonApiFactToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiFactToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFactToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFactToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiFactToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'sourceFact': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "dataset": dataset, + "sourceFact": sourceFact, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataset"]) -> MetaOapg.properties.dataset: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sourceFact"]) -> MetaOapg.properties.sourceFact: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataset", "sourceFact", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataset"]) -> typing.Union[MetaOapg.properties.dataset, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sourceFact"]) -> typing.Union[MetaOapg.properties.sourceFact, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataset", "sourceFact", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + dataset: typing.Union[MetaOapg.properties.dataset, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + sourceFact: typing.Union[MetaOapg.properties.sourceFact, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + dataset=dataset, + sourceFact=sourceFact, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + "meta": meta, + "relationships": relationships, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "meta", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "meta", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAggregatedFactOut': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + meta=meta, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_dataset_to_one_linkage import JsonApiDatasetToOneLinkage +from gooddata_api_client.model.json_api_fact_to_one_linkage import JsonApiFactToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_document.pyi new file mode 100644 index 000000000..89ae85d7e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_document.pyi @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAggregatedFactOutDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAggregatedFactOut']: + return JsonApiAggregatedFactOut + + + class included( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiAggregatedFactOutIncludes']: + return JsonApiAggregatedFactOutIncludes + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiAggregatedFactOutIncludes'], typing.List['JsonApiAggregatedFactOutIncludes']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'included': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiAggregatedFactOutIncludes': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ObjectLinks']: + return ObjectLinks + __annotations__ = { + "data": data, + "included": included, + "links": links, + } + + data: 'JsonApiAggregatedFactOut' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAggregatedFactOut': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAggregatedFactOut': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAggregatedFactOut', + included: typing.Union[MetaOapg.properties.included, list, tuple, schemas.Unset] = schemas.unset, + links: typing.Union['ObjectLinks', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAggregatedFactOutDocument': + return super().__new__( + cls, + *_args, + data=data, + included=included, + links=links, + _configuration=_configuration, + **kwargs, + ) + +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 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_includes.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_includes.pyi new file mode 100644 index 000000000..c0d9ff38a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_includes.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAggregatedFactOutIncludes( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + JsonApiDatasetOutWithLinks, + JsonApiFactOutWithLinks, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAggregatedFactOutIncludes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +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 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_list.pyi new file mode 100644 index 000000000..c92246d78 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_list.pyi @@ -0,0 +1,226 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAggregatedFactOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiAggregatedFactOutWithLinks']: + return JsonApiAggregatedFactOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiAggregatedFactOutWithLinks'], typing.List['JsonApiAggregatedFactOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiAggregatedFactOutWithLinks': + return super().__getitem__(i) + + + class included( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiAggregatedFactOutIncludes']: + return JsonApiAggregatedFactOutIncludes + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiAggregatedFactOutIncludes'], typing.List['JsonApiAggregatedFactOutIncludes']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'included': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiAggregatedFactOutIncludes': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "included": included, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + included: typing.Union[MetaOapg.properties.included, list, tuple, schemas.Unset] = schemas.unset, + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAggregatedFactOutList': + return super().__new__( + cls, + *_args, + data=data, + included=included, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_aggregated_fact_out_includes import JsonApiAggregatedFactOutIncludes +from gooddata_api_client.model.json_api_aggregated_fact_out_with_links import JsonApiAggregatedFactOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_with_links.pyi new file mode 100644 index 000000000..2b02d9f7c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAggregatedFactOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiAggregatedFactOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAggregatedFactOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_aggregated_fact_out import JsonApiAggregatedFactOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_to_many_linkage.pyi new file mode 100644 index 000000000..bfbba664c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_to_many_linkage.pyi @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAggregatedFactToManyLinkage( + schemas.ListSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + References to other resource objects in a to-many (\"relationship\"). Relationships can be specified by including a member in a resource's links object. + """ + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiAggregatedFactLinkage']: + return JsonApiAggregatedFactLinkage + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiAggregatedFactLinkage'], typing.List['JsonApiAggregatedFactLinkage']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'JsonApiAggregatedFactToManyLinkage': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiAggregatedFactLinkage': + return super().__getitem__(i) + +from gooddata_api_client.model.json_api_aggregated_fact_linkage import JsonApiAggregatedFactLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_attributes.py index 55ee43194..4c7c9dd92 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_attributes.py @@ -56,9 +56,17 @@ class JsonApiAnalyticalDashboardOutAttributes(ModelNormal): """ allowed_values = { + ('certification',): { + 'CERTIFIED': "CERTIFIED", + }, } validations = { + ('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 @@ -103,6 +111,9 @@ def openapi_types(): 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 'created_at': (datetime, none_type,), # noqa: E501 'description': (str,), # noqa: E501 'modified_at': (datetime, none_type,), # noqa: E501 @@ -119,6 +130,9 @@ def discriminator(): attribute_map = { '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 'description': 'description', # noqa: E501 'modified_at': 'modifiedAt', # noqa: E501 @@ -172,6 +186,9 @@ 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 + 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 description (str): [optional] # noqa: E501 modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 @@ -268,6 +285,9 @@ 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 + 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 description (str): [optional] # noqa: E501 modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 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 46dd683d0..4b4bb95da 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 @@ -32,7 +32,7 @@ def lazy_import(): 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_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_certified_by import JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy 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 @@ -40,7 +40,7 @@ def lazy_import(): 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 globals()['JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards'] = JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards - globals()['JsonApiAnalyticalDashboardOutRelationshipsCreatedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy + globals()['JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy globals()['JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins'] = JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins globals()['JsonApiAnalyticalDashboardOutRelationshipsDatasets'] = JsonApiAnalyticalDashboardOutRelationshipsDatasets globals()['JsonApiAnalyticalDashboardOutRelationshipsFilterContexts'] = JsonApiAnalyticalDashboardOutRelationshipsFilterContexts @@ -103,13 +103,14 @@ def openapi_types(): lazy_import() return { 'analytical_dashboards': (JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards,), # noqa: E501 - 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 + 'certified_by': (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy,), # noqa: E501 + 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy,), # noqa: E501 'dashboard_plugins': (JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins,), # noqa: E501 'datasets': (JsonApiAnalyticalDashboardOutRelationshipsDatasets,), # noqa: E501 'filter_contexts': (JsonApiAnalyticalDashboardOutRelationshipsFilterContexts,), # noqa: E501 'labels': (JsonApiAnalyticalDashboardOutRelationshipsLabels,), # noqa: E501 'metrics': (JsonApiAnalyticalDashboardOutRelationshipsMetrics,), # noqa: E501 - 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 + 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy,), # noqa: E501 'visualization_objects': (JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects,), # noqa: E501 } @@ -120,6 +121,7 @@ def discriminator(): attribute_map = { 'analytical_dashboards': 'analyticalDashboards', # noqa: E501 + 'certified_by': 'certifiedBy', # noqa: E501 'created_by': 'createdBy', # noqa: E501 'dashboard_plugins': 'dashboardPlugins', # noqa: E501 'datasets': 'datasets', # noqa: E501 @@ -172,13 +174,14 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) analytical_dashboards (JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + certified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 + created_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 dashboard_plugins (JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins): [optional] # noqa: E501 datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 filter_contexts (JsonApiAnalyticalDashboardOutRelationshipsFilterContexts): [optional] # noqa: E501 labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + modified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 visualization_objects (JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects): [optional] # noqa: E501 """ @@ -266,13 +269,14 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) analytical_dashboards (JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + certified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 + created_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 dashboard_plugins (JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins): [optional] # noqa: E501 datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 filter_contexts (JsonApiAnalyticalDashboardOutRelationshipsFilterContexts): [optional] # noqa: E501 labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + modified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 visualization_objects (JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_created_by.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_certified_by.py similarity index 97% rename from gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_created_by.py rename to gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_certified_by.py index 3eb449668..72712b03a 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_created_by.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_certified_by.py @@ -35,7 +35,7 @@ def lazy_import(): globals()['JsonApiUserIdentifierToOneLinkage'] = JsonApiUserIdentifierToOneLinkage -class JsonApiAnalyticalDashboardOutRelationshipsCreatedBy(ModelNormal): +class JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy(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 - """JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - a model defined in OpenAPI + """JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy - a model defined in OpenAPI Args: data (JsonApiUserIdentifierToOneLinkage): @@ -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 - """JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - a model defined in OpenAPI + """JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy - a model defined in OpenAPI Args: data (JsonApiUserIdentifierToOneLinkage): diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_to_one_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_to_one_linkage.pyi new file mode 100644 index 000000000..8b250c32d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_to_one_linkage.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAnalyticalDashboardToOneLinkage( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + JsonApiAnalyticalDashboardLinkage, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAnalyticalDashboardToOneLinkage': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_linkage import JsonApiAnalyticalDashboardLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_in.pyi new file mode 100644 index 000000000..34332ea64 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_in.pyi @@ -0,0 +1,243 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAttributeHierarchyIn( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of attributeHierarchy entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ATTRIBUTE_HIERARCHY(cls): + return cls("attributeHierarchy") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + areRelationsValid = schemas.BoolSchema + content = schemas.DictSchema + + + class description( + schemas.StrSchema + ): + pass + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "areRelationsValid": areRelationsValid, + "content": content, + "description": description, + "tags": tags, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union[MetaOapg.properties.content, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + content: typing.Union[MetaOapg.properties.content, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + areRelationsValid=areRelationsValid, + content=content, + description=description, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAttributeHierarchyIn': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_in_document.pyi new file mode 100644 index 000000000..be94f7c07 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_in_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAttributeHierarchyInDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAttributeHierarchyIn']: + return JsonApiAttributeHierarchyIn + __annotations__ = { + "data": data, + } + + data: 'JsonApiAttributeHierarchyIn' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeHierarchyIn': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeHierarchyIn': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAttributeHierarchyIn', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAttributeHierarchyInDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_attribute_hierarchy_in import JsonApiAttributeHierarchyIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_linkage.pyi new file mode 100644 index 000000000..30a434312 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_linkage.pyi @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAttributeHierarchyLinkage( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + The \"type\" and \"id\" to non-empty members. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ATTRIBUTE_HIERARCHY(cls): + return cls("attributeHierarchy") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAttributeHierarchyLinkage': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out.pyi new file mode 100644 index 000000000..6865b3fce --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out.pyi @@ -0,0 +1,702 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAttributeHierarchyOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of attributeHierarchy entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ATTRIBUTE_HIERARCHY(cls): + return cls("attributeHierarchy") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + areRelationsValid = schemas.BoolSchema + content = schemas.DictSchema + + + class createdAt( + schemas.DateTimeBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + format = 'date-time' + + + def __new__( + cls, + *_args: typing.Union[None, str, datetime, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'createdAt': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class description( + schemas.StrSchema + ): + pass + + + class modifiedAt( + schemas.DateTimeBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + format = 'date-time' + + + def __new__( + cls, + *_args: typing.Union[None, str, datetime, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'modifiedAt': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "areRelationsValid": areRelationsValid, + "content": content, + "createdAt": createdAt, + "description": description, + "modifiedAt": modifiedAt, + "tags": tags, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdAt"]) -> MetaOapg.properties.createdAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedAt"]) -> MetaOapg.properties.modifiedAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "createdAt", "description", "modifiedAt", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union[MetaOapg.properties.content, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdAt"]) -> typing.Union[MetaOapg.properties.createdAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedAt"]) -> typing.Union[MetaOapg.properties.modifiedAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "createdAt", "description", "modifiedAt", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + content: typing.Union[MetaOapg.properties.content, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + createdAt: typing.Union[MetaOapg.properties.createdAt, None, str, datetime, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + modifiedAt: typing.Union[MetaOapg.properties.modifiedAt, None, str, datetime, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + areRelationsValid=areRelationsValid, + content=content, + createdAt=createdAt, + description=description, + modifiedAt=modifiedAt, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class origin( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "originType", + "originId", + } + + class properties: + originId = schemas.StrSchema + + + class originType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") + + @schemas.classproperty + def PARENT(cls): + return cls("PARENT") + __annotations__ = { + "originId": originId, + "originType": originType, + } + + originType: MetaOapg.properties.originType + originId: MetaOapg.properties.originId + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + originType: typing.Union[MetaOapg.properties.originType, str, ], + originId: typing.Union[MetaOapg.properties.originId, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'origin': + return super().__new__( + cls, + *_args, + originType=originType, + originId=originId, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "origin": origin, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["origin"]) -> MetaOapg.properties.origin: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["origin"]) -> typing.Union[MetaOapg.properties.origin, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + origin: typing.Union[MetaOapg.properties.origin, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + origin=origin, + _configuration=_configuration, + **kwargs, + ) + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAttributeToManyLinkage']: + return JsonApiAttributeToManyLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAttributeToManyLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeToManyLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeToManyLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAttributeToManyLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class createdBy( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserIdentifierToOneLinkage']: + return JsonApiUserIdentifierToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserIdentifierToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserIdentifierToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'createdBy': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class modifiedBy( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserIdentifierToOneLinkage']: + return JsonApiUserIdentifierToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserIdentifierToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserIdentifierToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'modifiedBy': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "attributes": attributes, + "createdBy": createdBy, + "modifiedBy": modifiedBy, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdBy"]) -> MetaOapg.properties.createdBy: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedBy"]) -> MetaOapg.properties.modifiedBy: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "createdBy", "modifiedBy", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdBy"]) -> typing.Union[MetaOapg.properties.createdBy, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedBy"]) -> typing.Union[MetaOapg.properties.modifiedBy, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "createdBy", "modifiedBy", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + createdBy: typing.Union[MetaOapg.properties.createdBy, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + modifiedBy: typing.Union[MetaOapg.properties.modifiedBy, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + attributes=attributes, + createdBy=createdBy, + modifiedBy=modifiedBy, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + "meta": meta, + "relationships": relationships, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAttributeHierarchyOut': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + meta=meta, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_attribute_to_many_linkage import JsonApiAttributeToManyLinkage +from gooddata_api_client.model.json_api_user_identifier_to_one_linkage import JsonApiUserIdentifierToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_document.pyi new file mode 100644 index 000000000..55f278d89 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_document.pyi @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAttributeHierarchyOutDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAttributeHierarchyOut']: + return JsonApiAttributeHierarchyOut + + + class included( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiAttributeHierarchyOutIncludes']: + return JsonApiAttributeHierarchyOutIncludes + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiAttributeHierarchyOutIncludes'], typing.List['JsonApiAttributeHierarchyOutIncludes']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'included': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiAttributeHierarchyOutIncludes': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ObjectLinks']: + return ObjectLinks + __annotations__ = { + "data": data, + "included": included, + "links": links, + } + + data: 'JsonApiAttributeHierarchyOut' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeHierarchyOut': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeHierarchyOut': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAttributeHierarchyOut', + included: typing.Union[MetaOapg.properties.included, list, tuple, schemas.Unset] = schemas.unset, + links: typing.Union['ObjectLinks', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAttributeHierarchyOutDocument': + return super().__new__( + cls, + *_args, + data=data, + included=included, + links=links, + _configuration=_configuration, + **kwargs, + ) + +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 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_includes.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_includes.pyi new file mode 100644 index 000000000..5d1c91762 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_includes.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAttributeHierarchyOutIncludes( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + JsonApiUserIdentifierOutWithLinks, + JsonApiAttributeOutWithLinks, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAttributeHierarchyOutIncludes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks +from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_list.pyi new file mode 100644 index 000000000..92ceead95 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_list.pyi @@ -0,0 +1,226 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAttributeHierarchyOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiAttributeHierarchyOutWithLinks']: + return JsonApiAttributeHierarchyOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiAttributeHierarchyOutWithLinks'], typing.List['JsonApiAttributeHierarchyOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiAttributeHierarchyOutWithLinks': + return super().__getitem__(i) + + + class included( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiAttributeHierarchyOutIncludes']: + return JsonApiAttributeHierarchyOutIncludes + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiAttributeHierarchyOutIncludes'], typing.List['JsonApiAttributeHierarchyOutIncludes']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'included': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiAttributeHierarchyOutIncludes': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "included": included, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + included: typing.Union[MetaOapg.properties.included, list, tuple, schemas.Unset] = schemas.unset, + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAttributeHierarchyOutList': + return super().__new__( + cls, + *_args, + data=data, + included=included, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_attribute_hierarchy_out_includes import JsonApiAttributeHierarchyOutIncludes +from gooddata_api_client.model.json_api_attribute_hierarchy_out_with_links import JsonApiAttributeHierarchyOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_relationships.py index 098b15b1b..889684cec 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_relationships.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_relationships.py @@ -31,9 +31,9 @@ def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_certified_by import JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy from gooddata_api_client.model.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes - globals()['JsonApiAnalyticalDashboardOutRelationshipsCreatedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy + globals()['JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy globals()['JsonApiAttributeHierarchyOutRelationshipsAttributes'] = JsonApiAttributeHierarchyOutRelationshipsAttributes @@ -91,8 +91,8 @@ def openapi_types(): lazy_import() return { 'attributes': (JsonApiAttributeHierarchyOutRelationshipsAttributes,), # noqa: E501 - 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 + 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy,), # noqa: E501 + 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy,), # noqa: E501 } @cached_property @@ -148,8 +148,8 @@ 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 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + created_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 + modified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -236,8 +236,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + created_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 + modified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [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_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_with_links.pyi new file mode 100644 index 000000000..542d3f11b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAttributeHierarchyOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiAttributeHierarchyOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAttributeHierarchyOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_attribute_hierarchy_out import JsonApiAttributeHierarchyOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_patch.pyi new file mode 100644 index 000000000..9dd51761d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_patch.pyi @@ -0,0 +1,243 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAttributeHierarchyPatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching attributeHierarchy entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ATTRIBUTE_HIERARCHY(cls): + return cls("attributeHierarchy") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + areRelationsValid = schemas.BoolSchema + content = schemas.DictSchema + + + class description( + schemas.StrSchema + ): + pass + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "areRelationsValid": areRelationsValid, + "content": content, + "description": description, + "tags": tags, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union[MetaOapg.properties.content, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + content: typing.Union[MetaOapg.properties.content, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + areRelationsValid=areRelationsValid, + content=content, + description=description, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAttributeHierarchyPatch': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_patch_document.pyi new file mode 100644 index 000000000..9ec494df9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAttributeHierarchyPatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAttributeHierarchyPatch']: + return JsonApiAttributeHierarchyPatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiAttributeHierarchyPatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeHierarchyPatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributeHierarchyPatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAttributeHierarchyPatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAttributeHierarchyPatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_attribute_hierarchy_patch import JsonApiAttributeHierarchyPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_to_many_linkage.pyi new file mode 100644 index 000000000..4ff266976 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_to_many_linkage.pyi @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAttributeHierarchyToManyLinkage( + schemas.ListSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + References to other resource objects in a to-many (\"relationship\"). Relationships can be specified by including a member in a resource's links object. + """ + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiAttributeHierarchyLinkage']: + return JsonApiAttributeHierarchyLinkage + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiAttributeHierarchyLinkage'], typing.List['JsonApiAttributeHierarchyLinkage']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'JsonApiAttributeHierarchyToManyLinkage': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiAttributeHierarchyLinkage': + return super().__getitem__(i) + +from gooddata_api_client.model.json_api_attribute_hierarchy_linkage import JsonApiAttributeHierarchyLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_patch.pyi new file mode 100644 index 000000000..2bbef2e67 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_patch.pyi @@ -0,0 +1,341 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAttributePatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching attribute entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ATTRIBUTE(cls): + return cls("attribute") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class description( + schemas.StrSchema + ): + pass + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "description": description, + "tags": tags, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["description", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["description", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + description=description, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class defaultView( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiLabelToOneLinkage']: + return JsonApiLabelToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiLabelToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiLabelToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'defaultView': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "defaultView": defaultView, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["defaultView"]) -> MetaOapg.properties.defaultView: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["defaultView", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["defaultView"]) -> typing.Union[MetaOapg.properties.defaultView, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["defaultView", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + defaultView: typing.Union[MetaOapg.properties.defaultView, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + defaultView=defaultView, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + "relationships": relationships, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAttributePatch': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_label_to_one_linkage import JsonApiLabelToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_patch_document.pyi new file mode 100644 index 000000000..efa18726a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAttributePatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAttributePatch']: + return JsonApiAttributePatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiAttributePatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributePatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAttributePatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAttributePatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAttributePatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_attribute_patch import JsonApiAttributePatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in.pyi new file mode 100644 index 000000000..f7247856a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in.pyi @@ -0,0 +1,1604 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAutomationIn( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of automation entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def AUTOMATION(cls): + return cls("automation") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class alert( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "execution", + "condition", + } + + class properties: + + @staticmethod + def condition() -> typing.Type['AlertCondition']: + return AlertCondition + + @staticmethod + def execution() -> typing.Type['AlertAfm']: + return AlertAfm + + + class interval( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DAY(cls): + return cls("DAY") + + @schemas.classproperty + def WEEK(cls): + return cls("WEEK") + + @schemas.classproperty + def MONTH(cls): + return cls("MONTH") + + @schemas.classproperty + def QUARTER(cls): + return cls("QUARTER") + + @schemas.classproperty + def YEAR(cls): + return cls("YEAR") + + + class trigger( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ALWAYS(cls): + return cls("ALWAYS") + + @schemas.classproperty + def ONCE(cls): + return cls("ONCE") + + @schemas.classproperty + def ONCE_PER_INTERVAL(cls): + return cls("ONCE_PER_INTERVAL") + __annotations__ = { + "condition": condition, + "execution": execution, + "interval": interval, + "trigger": trigger, + } + + execution: 'AlertAfm' + condition: 'AlertCondition' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["condition"]) -> 'AlertCondition': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["execution"]) -> 'AlertAfm': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["interval"]) -> MetaOapg.properties.interval: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["trigger"]) -> MetaOapg.properties.trigger: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["condition", "execution", "interval", "trigger", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["condition"]) -> 'AlertCondition': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["execution"]) -> 'AlertAfm': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["interval"]) -> typing.Union[MetaOapg.properties.interval, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["trigger"]) -> typing.Union[MetaOapg.properties.trigger, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["condition", "execution", "interval", "trigger", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + execution: 'AlertAfm', + condition: 'AlertCondition', + interval: typing.Union[MetaOapg.properties.interval, str, schemas.Unset] = schemas.unset, + trigger: typing.Union[MetaOapg.properties.trigger, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'alert': + return super().__new__( + cls, + *_args, + execution=execution, + condition=condition, + interval=interval, + trigger=trigger, + _configuration=_configuration, + **kwargs, + ) + areRelationsValid = schemas.BoolSchema + + + class dashboardTabularExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['DashboardTabularExportRequestV2']: + return DashboardTabularExportRequestV2 + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'DashboardTabularExportRequestV2' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'DashboardTabularExportRequestV2': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'DashboardTabularExportRequestV2': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'DashboardTabularExportRequestV2', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dashboardTabularExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class description( + schemas.StrSchema + ): + pass + + + class details( + schemas.DictSchema + ): + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'details': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class evaluationMode( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SHARED(cls): + return cls("SHARED") + + @schemas.classproperty + def PER_RECIPIENT(cls): + return cls("PER_RECIPIENT") + + + class externalRecipients( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "email", + } + + class properties: + email = schemas.StrSchema + __annotations__ = { + "email": email, + } + + email: MetaOapg.properties.email + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["email", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["email", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + email: typing.Union[MetaOapg.properties.email, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + email=email, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'externalRecipients': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class imageExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['ImageExportRequest']: + return ImageExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'ImageExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'ImageExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'ImageExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'ImageExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'imageExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class metadata( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin + ): + + + class MetaOapg: + + class properties: + + + class visibleFilters( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['VisibleFilter']: + return VisibleFilter + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['VisibleFilter'], typing.List['VisibleFilter']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visibleFilters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'VisibleFilter': + return super().__getitem__(i) + widget = schemas.StrSchema + __annotations__ = { + "visibleFilters": visibleFilters, + "widget": widget, + } + additional_properties = schemas.AnyTypeSchema + + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visibleFilters"]) -> MetaOapg.properties.visibleFilters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widget"]) -> MetaOapg.properties.widget: ... + + @typing.overload + def __getitem__(self, name: str) -> MetaOapg.additional_properties: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["visibleFilters"], typing_extensions.Literal["widget"], str, ]): + # dict_instance[name] accessor + return super().__getitem__(name) + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visibleFilters"]) -> typing.Union[MetaOapg.properties.visibleFilters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widget"]) -> typing.Union[MetaOapg.properties.widget, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[MetaOapg.additional_properties, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["visibleFilters"], typing_extensions.Literal["widget"], str, ]): + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + visibleFilters: typing.Union[MetaOapg.properties.visibleFilters, list, tuple, schemas.Unset] = schemas.unset, + widget: typing.Union[MetaOapg.properties.widget, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + ) -> 'metadata': + return super().__new__( + cls, + *_args, + visibleFilters=visibleFilters, + widget=widget, + _configuration=_configuration, + **kwargs, + ) + + + class rawExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['RawExportAutomationRequest']: + return RawExportAutomationRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'RawExportAutomationRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'RawExportAutomationRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'RawExportAutomationRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'RawExportAutomationRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'rawExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class schedule( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "cron", + "timezone", + } + + class properties: + + + class cron( + schemas.StrSchema + ): + pass + cronDescription = schemas.StrSchema + firstRun = schemas.DateTimeSchema + + + class timezone( + schemas.StrSchema + ): + pass + __annotations__ = { + "cron": cron, + "cronDescription": cronDescription, + "firstRun": firstRun, + "timezone": timezone, + } + + cron: MetaOapg.properties.cron + timezone: MetaOapg.properties.timezone + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["cron"]) -> MetaOapg.properties.cron: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["cronDescription"]) -> MetaOapg.properties.cronDescription: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["firstRun"]) -> MetaOapg.properties.firstRun: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["timezone"]) -> MetaOapg.properties.timezone: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["cron", "cronDescription", "firstRun", "timezone", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["cron"]) -> MetaOapg.properties.cron: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["cronDescription"]) -> typing.Union[MetaOapg.properties.cronDescription, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["firstRun"]) -> typing.Union[MetaOapg.properties.firstRun, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["timezone"]) -> MetaOapg.properties.timezone: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["cron", "cronDescription", "firstRun", "timezone", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + cron: typing.Union[MetaOapg.properties.cron, str, ], + timezone: typing.Union[MetaOapg.properties.timezone, str, ], + cronDescription: typing.Union[MetaOapg.properties.cronDescription, str, schemas.Unset] = schemas.unset, + firstRun: typing.Union[MetaOapg.properties.firstRun, str, datetime, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'schedule': + return super().__new__( + cls, + *_args, + cron=cron, + timezone=timezone, + cronDescription=cronDescription, + firstRun=firstRun, + _configuration=_configuration, + **kwargs, + ) + + + class slidesExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['SlidesExportRequest']: + return SlidesExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'SlidesExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'SlidesExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'SlidesExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'SlidesExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'slidesExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class state( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ACTIVE(cls): + return cls("ACTIVE") + + @schemas.classproperty + def PAUSED(cls): + return cls("PAUSED") + + + class tabularExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['TabularExportRequest']: + return TabularExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'TabularExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'TabularExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'TabularExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'TabularExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tabularExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + + + class visualExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['VisualExportRequest']: + return VisualExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'VisualExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'VisualExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'VisualExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'VisualExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visualExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "alert": alert, + "areRelationsValid": areRelationsValid, + "dashboardTabularExports": dashboardTabularExports, + "description": description, + "details": details, + "evaluationMode": evaluationMode, + "externalRecipients": externalRecipients, + "imageExports": imageExports, + "metadata": metadata, + "rawExports": rawExports, + "schedule": schedule, + "slidesExports": slidesExports, + "state": state, + "tabularExports": tabularExports, + "tags": tags, + "title": title, + "visualExports": visualExports, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["alert"]) -> MetaOapg.properties.alert: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardTabularExports"]) -> MetaOapg.properties.dashboardTabularExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["details"]) -> MetaOapg.properties.details: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["evaluationMode"]) -> MetaOapg.properties.evaluationMode: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["externalRecipients"]) -> MetaOapg.properties.externalRecipients: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["imageExports"]) -> MetaOapg.properties.imageExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metadata"]) -> MetaOapg.properties.metadata: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rawExports"]) -> MetaOapg.properties.rawExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["schedule"]) -> MetaOapg.properties.schedule: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["slidesExports"]) -> MetaOapg.properties.slidesExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["state"]) -> MetaOapg.properties.state: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tabularExports"]) -> MetaOapg.properties.tabularExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualExports"]) -> MetaOapg.properties.visualExports: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["alert", "areRelationsValid", "dashboardTabularExports", "description", "details", "evaluationMode", "externalRecipients", "imageExports", "metadata", "rawExports", "schedule", "slidesExports", "state", "tabularExports", "tags", "title", "visualExports", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["alert"]) -> typing.Union[MetaOapg.properties.alert, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardTabularExports"]) -> typing.Union[MetaOapg.properties.dashboardTabularExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["details"]) -> typing.Union[MetaOapg.properties.details, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["evaluationMode"]) -> typing.Union[MetaOapg.properties.evaluationMode, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["externalRecipients"]) -> typing.Union[MetaOapg.properties.externalRecipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["imageExports"]) -> typing.Union[MetaOapg.properties.imageExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metadata"]) -> typing.Union[MetaOapg.properties.metadata, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rawExports"]) -> typing.Union[MetaOapg.properties.rawExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["schedule"]) -> typing.Union[MetaOapg.properties.schedule, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["slidesExports"]) -> typing.Union[MetaOapg.properties.slidesExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["state"]) -> typing.Union[MetaOapg.properties.state, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tabularExports"]) -> typing.Union[MetaOapg.properties.tabularExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualExports"]) -> typing.Union[MetaOapg.properties.visualExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["alert", "areRelationsValid", "dashboardTabularExports", "description", "details", "evaluationMode", "externalRecipients", "imageExports", "metadata", "rawExports", "schedule", "slidesExports", "state", "tabularExports", "tags", "title", "visualExports", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + alert: typing.Union[MetaOapg.properties.alert, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + dashboardTabularExports: typing.Union[MetaOapg.properties.dashboardTabularExports, list, tuple, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + details: typing.Union[MetaOapg.properties.details, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + evaluationMode: typing.Union[MetaOapg.properties.evaluationMode, str, schemas.Unset] = schemas.unset, + externalRecipients: typing.Union[MetaOapg.properties.externalRecipients, list, tuple, schemas.Unset] = schemas.unset, + imageExports: typing.Union[MetaOapg.properties.imageExports, list, tuple, schemas.Unset] = schemas.unset, + metadata: typing.Union[MetaOapg.properties.metadata, dict, frozendict.frozendict, None, schemas.Unset] = schemas.unset, + rawExports: typing.Union[MetaOapg.properties.rawExports, list, tuple, schemas.Unset] = schemas.unset, + schedule: typing.Union[MetaOapg.properties.schedule, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + slidesExports: typing.Union[MetaOapg.properties.slidesExports, list, tuple, schemas.Unset] = schemas.unset, + state: typing.Union[MetaOapg.properties.state, str, schemas.Unset] = schemas.unset, + tabularExports: typing.Union[MetaOapg.properties.tabularExports, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + visualExports: typing.Union[MetaOapg.properties.visualExports, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + alert=alert, + areRelationsValid=areRelationsValid, + dashboardTabularExports=dashboardTabularExports, + description=description, + details=details, + evaluationMode=evaluationMode, + externalRecipients=externalRecipients, + imageExports=imageExports, + metadata=metadata, + rawExports=rawExports, + schedule=schedule, + slidesExports=slidesExports, + state=state, + tabularExports=tabularExports, + tags=tags, + title=title, + visualExports=visualExports, + _configuration=_configuration, + **kwargs, + ) + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class analyticalDashboard( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAnalyticalDashboardToOneLinkage']: + return JsonApiAnalyticalDashboardToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAnalyticalDashboardToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAnalyticalDashboardToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'analyticalDashboard': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class exportDefinitions( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiExportDefinitionToManyLinkage']: + return JsonApiExportDefinitionToManyLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiExportDefinitionToManyLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportDefinitionToManyLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportDefinitionToManyLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiExportDefinitionToManyLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'exportDefinitions': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class notificationChannel( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiNotificationChannelToOneLinkage']: + return JsonApiNotificationChannelToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiNotificationChannelToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiNotificationChannelToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'notificationChannel': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class recipients( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserToManyLinkage']: + return JsonApiUserToManyLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserToManyLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToManyLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToManyLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserToManyLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'recipients': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "analyticalDashboard": analyticalDashboard, + "exportDefinitions": exportDefinitions, + "notificationChannel": notificationChannel, + "recipients": recipients, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> MetaOapg.properties.analyticalDashboard: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["exportDefinitions"]) -> MetaOapg.properties.exportDefinitions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["notificationChannel"]) -> MetaOapg.properties.notificationChannel: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["recipients"]) -> MetaOapg.properties.recipients: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "exportDefinitions", "notificationChannel", "recipients", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union[MetaOapg.properties.analyticalDashboard, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["exportDefinitions"]) -> typing.Union[MetaOapg.properties.exportDefinitions, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["notificationChannel"]) -> typing.Union[MetaOapg.properties.notificationChannel, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["recipients"]) -> typing.Union[MetaOapg.properties.recipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "exportDefinitions", "notificationChannel", "recipients", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + analyticalDashboard: typing.Union[MetaOapg.properties.analyticalDashboard, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + exportDefinitions: typing.Union[MetaOapg.properties.exportDefinitions, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + notificationChannel: typing.Union[MetaOapg.properties.notificationChannel, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + recipients: typing.Union[MetaOapg.properties.recipients, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + analyticalDashboard=analyticalDashboard, + exportDefinitions=exportDefinitions, + notificationChannel=notificationChannel, + recipients=recipients, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + "relationships": relationships, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAutomationIn': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.alert_afm import AlertAfm +from gooddata_api_client.model.alert_condition import AlertCondition +from gooddata_api_client.model.dashboard_tabular_export_request_v2 import DashboardTabularExportRequestV2 +from gooddata_api_client.model.image_export_request import ImageExportRequest +from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.model.json_api_export_definition_to_many_linkage import JsonApiExportDefinitionToManyLinkage +from gooddata_api_client.model.json_api_notification_channel_to_one_linkage import JsonApiNotificationChannelToOneLinkage +from gooddata_api_client.model.json_api_user_to_many_linkage import JsonApiUserToManyLinkage +from gooddata_api_client.model.raw_export_automation_request import RawExportAutomationRequest +from gooddata_api_client.model.slides_export_request import SlidesExportRequest +from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.model.visible_filter import VisibleFilter +from gooddata_api_client.model.visual_export_request import VisualExportRequest diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_document.pyi new file mode 100644 index 000000000..f328e27ba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAutomationInDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAutomationIn']: + return JsonApiAutomationIn + __annotations__ = { + "data": data, + } + + data: 'JsonApiAutomationIn' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAutomationIn': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAutomationIn': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAutomationIn', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAutomationInDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_automation_in import JsonApiAutomationIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_automation_linkage.pyi new file mode 100644 index 000000000..5d3bb599a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_linkage.pyi @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAutomationLinkage( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + The \"type\" and \"id\" to non-empty members. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def AUTOMATION(cls): + return cls("automation") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAutomationLinkage': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out.pyi new file mode 100644 index 000000000..0c21b51d3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out.pyi @@ -0,0 +1,2013 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAutomationOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of automation entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def AUTOMATION(cls): + return cls("automation") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class alert( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "execution", + "condition", + } + + class properties: + + @staticmethod + def condition() -> typing.Type['AlertCondition']: + return AlertCondition + + @staticmethod + def execution() -> typing.Type['AlertAfm']: + return AlertAfm + + + class interval( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DAY(cls): + return cls("DAY") + + @schemas.classproperty + def WEEK(cls): + return cls("WEEK") + + @schemas.classproperty + def MONTH(cls): + return cls("MONTH") + + @schemas.classproperty + def QUARTER(cls): + return cls("QUARTER") + + @schemas.classproperty + def YEAR(cls): + return cls("YEAR") + + + class trigger( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ALWAYS(cls): + return cls("ALWAYS") + + @schemas.classproperty + def ONCE(cls): + return cls("ONCE") + + @schemas.classproperty + def ONCE_PER_INTERVAL(cls): + return cls("ONCE_PER_INTERVAL") + __annotations__ = { + "condition": condition, + "execution": execution, + "interval": interval, + "trigger": trigger, + } + + execution: 'AlertAfm' + condition: 'AlertCondition' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["condition"]) -> 'AlertCondition': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["execution"]) -> 'AlertAfm': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["interval"]) -> MetaOapg.properties.interval: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["trigger"]) -> MetaOapg.properties.trigger: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["condition", "execution", "interval", "trigger", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["condition"]) -> 'AlertCondition': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["execution"]) -> 'AlertAfm': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["interval"]) -> typing.Union[MetaOapg.properties.interval, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["trigger"]) -> typing.Union[MetaOapg.properties.trigger, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["condition", "execution", "interval", "trigger", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + execution: 'AlertAfm', + condition: 'AlertCondition', + interval: typing.Union[MetaOapg.properties.interval, str, schemas.Unset] = schemas.unset, + trigger: typing.Union[MetaOapg.properties.trigger, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'alert': + return super().__new__( + cls, + *_args, + execution=execution, + condition=condition, + interval=interval, + trigger=trigger, + _configuration=_configuration, + **kwargs, + ) + areRelationsValid = schemas.BoolSchema + + + class createdAt( + schemas.DateTimeBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + format = 'date-time' + + + def __new__( + cls, + *_args: typing.Union[None, str, datetime, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'createdAt': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class dashboardTabularExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['DashboardTabularExportRequestV2']: + return DashboardTabularExportRequestV2 + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'DashboardTabularExportRequestV2' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'DashboardTabularExportRequestV2': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'DashboardTabularExportRequestV2': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'DashboardTabularExportRequestV2', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dashboardTabularExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class description( + schemas.StrSchema + ): + pass + + + class details( + schemas.DictSchema + ): + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'details': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class evaluationMode( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SHARED(cls): + return cls("SHARED") + + @schemas.classproperty + def PER_RECIPIENT(cls): + return cls("PER_RECIPIENT") + + + class externalRecipients( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "email", + } + + class properties: + email = schemas.StrSchema + __annotations__ = { + "email": email, + } + + email: MetaOapg.properties.email + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["email", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["email", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + email: typing.Union[MetaOapg.properties.email, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + email=email, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'externalRecipients': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class imageExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['ImageExportRequest']: + return ImageExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'ImageExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'ImageExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'ImageExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'ImageExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'imageExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class metadata( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin + ): + + + class MetaOapg: + + class properties: + + + class visibleFilters( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['VisibleFilter']: + return VisibleFilter + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['VisibleFilter'], typing.List['VisibleFilter']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visibleFilters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'VisibleFilter': + return super().__getitem__(i) + widget = schemas.StrSchema + __annotations__ = { + "visibleFilters": visibleFilters, + "widget": widget, + } + additional_properties = schemas.AnyTypeSchema + + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visibleFilters"]) -> MetaOapg.properties.visibleFilters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widget"]) -> MetaOapg.properties.widget: ... + + @typing.overload + def __getitem__(self, name: str) -> MetaOapg.additional_properties: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["visibleFilters"], typing_extensions.Literal["widget"], str, ]): + # dict_instance[name] accessor + return super().__getitem__(name) + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visibleFilters"]) -> typing.Union[MetaOapg.properties.visibleFilters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widget"]) -> typing.Union[MetaOapg.properties.widget, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[MetaOapg.additional_properties, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["visibleFilters"], typing_extensions.Literal["widget"], str, ]): + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + visibleFilters: typing.Union[MetaOapg.properties.visibleFilters, list, tuple, schemas.Unset] = schemas.unset, + widget: typing.Union[MetaOapg.properties.widget, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + ) -> 'metadata': + return super().__new__( + cls, + *_args, + visibleFilters=visibleFilters, + widget=widget, + _configuration=_configuration, + **kwargs, + ) + + + class modifiedAt( + schemas.DateTimeBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + format = 'date-time' + + + def __new__( + cls, + *_args: typing.Union[None, str, datetime, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'modifiedAt': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class rawExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['RawExportAutomationRequest']: + return RawExportAutomationRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'RawExportAutomationRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'RawExportAutomationRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'RawExportAutomationRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'RawExportAutomationRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'rawExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class schedule( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "cron", + "timezone", + } + + class properties: + + + class cron( + schemas.StrSchema + ): + pass + cronDescription = schemas.StrSchema + firstRun = schemas.DateTimeSchema + + + class timezone( + schemas.StrSchema + ): + pass + __annotations__ = { + "cron": cron, + "cronDescription": cronDescription, + "firstRun": firstRun, + "timezone": timezone, + } + + cron: MetaOapg.properties.cron + timezone: MetaOapg.properties.timezone + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["cron"]) -> MetaOapg.properties.cron: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["cronDescription"]) -> MetaOapg.properties.cronDescription: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["firstRun"]) -> MetaOapg.properties.firstRun: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["timezone"]) -> MetaOapg.properties.timezone: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["cron", "cronDescription", "firstRun", "timezone", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["cron"]) -> MetaOapg.properties.cron: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["cronDescription"]) -> typing.Union[MetaOapg.properties.cronDescription, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["firstRun"]) -> typing.Union[MetaOapg.properties.firstRun, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["timezone"]) -> MetaOapg.properties.timezone: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["cron", "cronDescription", "firstRun", "timezone", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + cron: typing.Union[MetaOapg.properties.cron, str, ], + timezone: typing.Union[MetaOapg.properties.timezone, str, ], + cronDescription: typing.Union[MetaOapg.properties.cronDescription, str, schemas.Unset] = schemas.unset, + firstRun: typing.Union[MetaOapg.properties.firstRun, str, datetime, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'schedule': + return super().__new__( + cls, + *_args, + cron=cron, + timezone=timezone, + cronDescription=cronDescription, + firstRun=firstRun, + _configuration=_configuration, + **kwargs, + ) + + + class slidesExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['SlidesExportRequest']: + return SlidesExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'SlidesExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'SlidesExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'SlidesExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'SlidesExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'slidesExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class state( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ACTIVE(cls): + return cls("ACTIVE") + + @schemas.classproperty + def PAUSED(cls): + return cls("PAUSED") + + + class tabularExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['TabularExportRequest']: + return TabularExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'TabularExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'TabularExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'TabularExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'TabularExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tabularExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + + + class visualExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['VisualExportRequest']: + return VisualExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'VisualExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'VisualExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'VisualExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'VisualExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visualExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "alert": alert, + "areRelationsValid": areRelationsValid, + "createdAt": createdAt, + "dashboardTabularExports": dashboardTabularExports, + "description": description, + "details": details, + "evaluationMode": evaluationMode, + "externalRecipients": externalRecipients, + "imageExports": imageExports, + "metadata": metadata, + "modifiedAt": modifiedAt, + "rawExports": rawExports, + "schedule": schedule, + "slidesExports": slidesExports, + "state": state, + "tabularExports": tabularExports, + "tags": tags, + "title": title, + "visualExports": visualExports, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["alert"]) -> MetaOapg.properties.alert: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdAt"]) -> MetaOapg.properties.createdAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardTabularExports"]) -> MetaOapg.properties.dashboardTabularExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["details"]) -> MetaOapg.properties.details: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["evaluationMode"]) -> MetaOapg.properties.evaluationMode: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["externalRecipients"]) -> MetaOapg.properties.externalRecipients: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["imageExports"]) -> MetaOapg.properties.imageExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metadata"]) -> MetaOapg.properties.metadata: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedAt"]) -> MetaOapg.properties.modifiedAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rawExports"]) -> MetaOapg.properties.rawExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["schedule"]) -> MetaOapg.properties.schedule: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["slidesExports"]) -> MetaOapg.properties.slidesExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["state"]) -> MetaOapg.properties.state: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tabularExports"]) -> MetaOapg.properties.tabularExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualExports"]) -> MetaOapg.properties.visualExports: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["alert", "areRelationsValid", "createdAt", "dashboardTabularExports", "description", "details", "evaluationMode", "externalRecipients", "imageExports", "metadata", "modifiedAt", "rawExports", "schedule", "slidesExports", "state", "tabularExports", "tags", "title", "visualExports", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["alert"]) -> typing.Union[MetaOapg.properties.alert, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdAt"]) -> typing.Union[MetaOapg.properties.createdAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardTabularExports"]) -> typing.Union[MetaOapg.properties.dashboardTabularExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["details"]) -> typing.Union[MetaOapg.properties.details, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["evaluationMode"]) -> typing.Union[MetaOapg.properties.evaluationMode, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["externalRecipients"]) -> typing.Union[MetaOapg.properties.externalRecipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["imageExports"]) -> typing.Union[MetaOapg.properties.imageExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metadata"]) -> typing.Union[MetaOapg.properties.metadata, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedAt"]) -> typing.Union[MetaOapg.properties.modifiedAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rawExports"]) -> typing.Union[MetaOapg.properties.rawExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["schedule"]) -> typing.Union[MetaOapg.properties.schedule, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["slidesExports"]) -> typing.Union[MetaOapg.properties.slidesExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["state"]) -> typing.Union[MetaOapg.properties.state, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tabularExports"]) -> typing.Union[MetaOapg.properties.tabularExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualExports"]) -> typing.Union[MetaOapg.properties.visualExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["alert", "areRelationsValid", "createdAt", "dashboardTabularExports", "description", "details", "evaluationMode", "externalRecipients", "imageExports", "metadata", "modifiedAt", "rawExports", "schedule", "slidesExports", "state", "tabularExports", "tags", "title", "visualExports", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + alert: typing.Union[MetaOapg.properties.alert, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + createdAt: typing.Union[MetaOapg.properties.createdAt, None, str, datetime, schemas.Unset] = schemas.unset, + dashboardTabularExports: typing.Union[MetaOapg.properties.dashboardTabularExports, list, tuple, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + details: typing.Union[MetaOapg.properties.details, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + evaluationMode: typing.Union[MetaOapg.properties.evaluationMode, str, schemas.Unset] = schemas.unset, + externalRecipients: typing.Union[MetaOapg.properties.externalRecipients, list, tuple, schemas.Unset] = schemas.unset, + imageExports: typing.Union[MetaOapg.properties.imageExports, list, tuple, schemas.Unset] = schemas.unset, + metadata: typing.Union[MetaOapg.properties.metadata, dict, frozendict.frozendict, None, schemas.Unset] = schemas.unset, + modifiedAt: typing.Union[MetaOapg.properties.modifiedAt, None, str, datetime, schemas.Unset] = schemas.unset, + rawExports: typing.Union[MetaOapg.properties.rawExports, list, tuple, schemas.Unset] = schemas.unset, + schedule: typing.Union[MetaOapg.properties.schedule, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + slidesExports: typing.Union[MetaOapg.properties.slidesExports, list, tuple, schemas.Unset] = schemas.unset, + state: typing.Union[MetaOapg.properties.state, str, schemas.Unset] = schemas.unset, + tabularExports: typing.Union[MetaOapg.properties.tabularExports, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + visualExports: typing.Union[MetaOapg.properties.visualExports, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + alert=alert, + areRelationsValid=areRelationsValid, + createdAt=createdAt, + dashboardTabularExports=dashboardTabularExports, + description=description, + details=details, + evaluationMode=evaluationMode, + externalRecipients=externalRecipients, + imageExports=imageExports, + metadata=metadata, + modifiedAt=modifiedAt, + rawExports=rawExports, + schedule=schedule, + slidesExports=slidesExports, + state=state, + tabularExports=tabularExports, + tags=tags, + title=title, + visualExports=visualExports, + _configuration=_configuration, + **kwargs, + ) + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class origin( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "originType", + "originId", + } + + class properties: + originId = schemas.StrSchema + + + class originType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") + + @schemas.classproperty + def PARENT(cls): + return cls("PARENT") + __annotations__ = { + "originId": originId, + "originType": originType, + } + + originType: MetaOapg.properties.originType + originId: MetaOapg.properties.originId + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + originType: typing.Union[MetaOapg.properties.originType, str, ], + originId: typing.Union[MetaOapg.properties.originId, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'origin': + return super().__new__( + cls, + *_args, + originType=originType, + originId=originId, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "origin": origin, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["origin"]) -> MetaOapg.properties.origin: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["origin"]) -> typing.Union[MetaOapg.properties.origin, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + origin: typing.Union[MetaOapg.properties.origin, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + origin=origin, + _configuration=_configuration, + **kwargs, + ) + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class analyticalDashboard( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAnalyticalDashboardToOneLinkage']: + return JsonApiAnalyticalDashboardToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAnalyticalDashboardToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAnalyticalDashboardToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'analyticalDashboard': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class automationResults( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAutomationResultToManyLinkage']: + return JsonApiAutomationResultToManyLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAutomationResultToManyLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAutomationResultToManyLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAutomationResultToManyLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAutomationResultToManyLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'automationResults': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class createdBy( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserIdentifierToOneLinkage']: + return JsonApiUserIdentifierToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserIdentifierToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserIdentifierToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'createdBy': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class exportDefinitions( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiExportDefinitionToManyLinkage']: + return JsonApiExportDefinitionToManyLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiExportDefinitionToManyLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportDefinitionToManyLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportDefinitionToManyLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiExportDefinitionToManyLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'exportDefinitions': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class modifiedBy( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserIdentifierToOneLinkage']: + return JsonApiUserIdentifierToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserIdentifierToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserIdentifierToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'modifiedBy': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class notificationChannel( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiNotificationChannelToOneLinkage']: + return JsonApiNotificationChannelToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiNotificationChannelToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiNotificationChannelToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'notificationChannel': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class recipients( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserToManyLinkage']: + return JsonApiUserToManyLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserToManyLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToManyLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToManyLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserToManyLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'recipients': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "analyticalDashboard": analyticalDashboard, + "automationResults": automationResults, + "createdBy": createdBy, + "exportDefinitions": exportDefinitions, + "modifiedBy": modifiedBy, + "notificationChannel": notificationChannel, + "recipients": recipients, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> MetaOapg.properties.analyticalDashboard: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["automationResults"]) -> MetaOapg.properties.automationResults: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdBy"]) -> MetaOapg.properties.createdBy: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["exportDefinitions"]) -> MetaOapg.properties.exportDefinitions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedBy"]) -> MetaOapg.properties.modifiedBy: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["notificationChannel"]) -> MetaOapg.properties.notificationChannel: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["recipients"]) -> MetaOapg.properties.recipients: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "automationResults", "createdBy", "exportDefinitions", "modifiedBy", "notificationChannel", "recipients", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union[MetaOapg.properties.analyticalDashboard, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["automationResults"]) -> typing.Union[MetaOapg.properties.automationResults, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdBy"]) -> typing.Union[MetaOapg.properties.createdBy, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["exportDefinitions"]) -> typing.Union[MetaOapg.properties.exportDefinitions, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedBy"]) -> typing.Union[MetaOapg.properties.modifiedBy, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["notificationChannel"]) -> typing.Union[MetaOapg.properties.notificationChannel, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["recipients"]) -> typing.Union[MetaOapg.properties.recipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "automationResults", "createdBy", "exportDefinitions", "modifiedBy", "notificationChannel", "recipients", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + analyticalDashboard: typing.Union[MetaOapg.properties.analyticalDashboard, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + automationResults: typing.Union[MetaOapg.properties.automationResults, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + createdBy: typing.Union[MetaOapg.properties.createdBy, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + exportDefinitions: typing.Union[MetaOapg.properties.exportDefinitions, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + modifiedBy: typing.Union[MetaOapg.properties.modifiedBy, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + notificationChannel: typing.Union[MetaOapg.properties.notificationChannel, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + recipients: typing.Union[MetaOapg.properties.recipients, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + analyticalDashboard=analyticalDashboard, + automationResults=automationResults, + createdBy=createdBy, + exportDefinitions=exportDefinitions, + modifiedBy=modifiedBy, + notificationChannel=notificationChannel, + recipients=recipients, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + "meta": meta, + "relationships": relationships, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAutomationOut': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + meta=meta, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.alert_afm import AlertAfm +from gooddata_api_client.model.alert_condition import AlertCondition +from gooddata_api_client.model.dashboard_tabular_export_request_v2 import DashboardTabularExportRequestV2 +from gooddata_api_client.model.image_export_request import ImageExportRequest +from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.model.json_api_automation_result_to_many_linkage import JsonApiAutomationResultToManyLinkage +from gooddata_api_client.model.json_api_export_definition_to_many_linkage import JsonApiExportDefinitionToManyLinkage +from gooddata_api_client.model.json_api_notification_channel_to_one_linkage import JsonApiNotificationChannelToOneLinkage +from gooddata_api_client.model.json_api_user_identifier_to_one_linkage import JsonApiUserIdentifierToOneLinkage +from gooddata_api_client.model.json_api_user_to_many_linkage import JsonApiUserToManyLinkage +from gooddata_api_client.model.raw_export_automation_request import RawExportAutomationRequest +from gooddata_api_client.model.slides_export_request import SlidesExportRequest +from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.model.visible_filter import VisibleFilter +from gooddata_api_client.model.visual_export_request import VisualExportRequest diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_document.pyi new file mode 100644 index 000000000..381655f0f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_document.pyi @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAutomationOutDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAutomationOut']: + return JsonApiAutomationOut + + + class included( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiAutomationOutIncludes']: + return JsonApiAutomationOutIncludes + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiAutomationOutIncludes'], typing.List['JsonApiAutomationOutIncludes']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'included': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiAutomationOutIncludes': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ObjectLinks']: + return ObjectLinks + __annotations__ = { + "data": data, + "included": included, + "links": links, + } + + data: 'JsonApiAutomationOut' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAutomationOut': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAutomationOut': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAutomationOut', + included: typing.Union[MetaOapg.properties.included, list, tuple, schemas.Unset] = schemas.unset, + links: typing.Union['ObjectLinks', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAutomationOutDocument': + return super().__new__( + cls, + *_args, + data=data, + included=included, + links=links, + _configuration=_configuration, + **kwargs, + ) + +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 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_includes.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_includes.pyi new file mode 100644 index 000000000..68376159e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_includes.pyi @@ -0,0 +1,77 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAutomationOutIncludes( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + JsonApiNotificationChannelOutWithLinks, + JsonApiAnalyticalDashboardOutWithLinks, + JsonApiUserIdentifierOutWithLinks, + JsonApiExportDefinitionOutWithLinks, + JsonApiUserOutWithLinks, + JsonApiAutomationResultOutWithLinks, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAutomationOutIncludes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks +from gooddata_api_client.model.json_api_automation_result_out_with_links import JsonApiAutomationResultOutWithLinks +from gooddata_api_client.model.json_api_export_definition_out_with_links import JsonApiExportDefinitionOutWithLinks +from gooddata_api_client.model.json_api_notification_channel_out_with_links import JsonApiNotificationChannelOutWithLinks +from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks +from gooddata_api_client.model.json_api_user_out_with_links import JsonApiUserOutWithLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_list.pyi new file mode 100644 index 000000000..02f8429b7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_list.pyi @@ -0,0 +1,226 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAutomationOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiAutomationOutWithLinks']: + return JsonApiAutomationOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiAutomationOutWithLinks'], typing.List['JsonApiAutomationOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiAutomationOutWithLinks': + return super().__getitem__(i) + + + class included( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiAutomationOutIncludes']: + return JsonApiAutomationOutIncludes + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiAutomationOutIncludes'], typing.List['JsonApiAutomationOutIncludes']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'included': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiAutomationOutIncludes': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "included": included, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + included: typing.Union[MetaOapg.properties.included, list, tuple, schemas.Unset] = schemas.unset, + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAutomationOutList': + return super().__new__( + cls, + *_args, + data=data, + included=included, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_automation_out_includes import JsonApiAutomationOutIncludes +from gooddata_api_client.model.json_api_automation_out_with_links import JsonApiAutomationOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata 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 3cb64f625..4b5ad53cf 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 @@ -31,13 +31,13 @@ def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_certified_by import JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy 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 - globals()['JsonApiAnalyticalDashboardOutRelationshipsCreatedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy + globals()['JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy globals()['JsonApiAutomationInRelationshipsAnalyticalDashboard'] = JsonApiAutomationInRelationshipsAnalyticalDashboard globals()['JsonApiAutomationInRelationshipsExportDefinitions'] = JsonApiAutomationInRelationshipsExportDefinitions globals()['JsonApiAutomationInRelationshipsNotificationChannel'] = JsonApiAutomationInRelationshipsNotificationChannel @@ -100,9 +100,9 @@ def openapi_types(): return { 'analytical_dashboard': (JsonApiAutomationInRelationshipsAnalyticalDashboard,), # noqa: E501 'automation_results': (JsonApiAutomationOutRelationshipsAutomationResults,), # noqa: E501 - 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 + 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy,), # noqa: E501 'export_definitions': (JsonApiAutomationInRelationshipsExportDefinitions,), # noqa: E501 - 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 + 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy,), # noqa: E501 'notification_channel': (JsonApiAutomationInRelationshipsNotificationChannel,), # noqa: E501 'recipients': (JsonApiAutomationInRelationshipsRecipients,), # noqa: E501 } @@ -165,9 +165,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 automation_results (JsonApiAutomationOutRelationshipsAutomationResults): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + created_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 export_definitions (JsonApiAutomationInRelationshipsExportDefinitions): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + modified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 notification_channel (JsonApiAutomationInRelationshipsNotificationChannel): [optional] # noqa: E501 recipients (JsonApiAutomationInRelationshipsRecipients): [optional] # noqa: E501 """ @@ -257,9 +257,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 automation_results (JsonApiAutomationOutRelationshipsAutomationResults): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + created_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 export_definitions (JsonApiAutomationInRelationshipsExportDefinitions): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + modified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 notification_channel (JsonApiAutomationInRelationshipsNotificationChannel): [optional] # noqa: E501 recipients (JsonApiAutomationInRelationshipsRecipients): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_with_links.pyi new file mode 100644 index 000000000..37bcbb84b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAutomationOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiAutomationOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAutomationOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_automation_out import JsonApiAutomationOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_automation_patch.pyi new file mode 100644 index 000000000..c856455ae --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_patch.pyi @@ -0,0 +1,1604 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAutomationPatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching automation entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def AUTOMATION(cls): + return cls("automation") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class alert( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "execution", + "condition", + } + + class properties: + + @staticmethod + def condition() -> typing.Type['AlertCondition']: + return AlertCondition + + @staticmethod + def execution() -> typing.Type['AlertAfm']: + return AlertAfm + + + class interval( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DAY(cls): + return cls("DAY") + + @schemas.classproperty + def WEEK(cls): + return cls("WEEK") + + @schemas.classproperty + def MONTH(cls): + return cls("MONTH") + + @schemas.classproperty + def QUARTER(cls): + return cls("QUARTER") + + @schemas.classproperty + def YEAR(cls): + return cls("YEAR") + + + class trigger( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ALWAYS(cls): + return cls("ALWAYS") + + @schemas.classproperty + def ONCE(cls): + return cls("ONCE") + + @schemas.classproperty + def ONCE_PER_INTERVAL(cls): + return cls("ONCE_PER_INTERVAL") + __annotations__ = { + "condition": condition, + "execution": execution, + "interval": interval, + "trigger": trigger, + } + + execution: 'AlertAfm' + condition: 'AlertCondition' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["condition"]) -> 'AlertCondition': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["execution"]) -> 'AlertAfm': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["interval"]) -> MetaOapg.properties.interval: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["trigger"]) -> MetaOapg.properties.trigger: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["condition", "execution", "interval", "trigger", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["condition"]) -> 'AlertCondition': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["execution"]) -> 'AlertAfm': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["interval"]) -> typing.Union[MetaOapg.properties.interval, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["trigger"]) -> typing.Union[MetaOapg.properties.trigger, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["condition", "execution", "interval", "trigger", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + execution: 'AlertAfm', + condition: 'AlertCondition', + interval: typing.Union[MetaOapg.properties.interval, str, schemas.Unset] = schemas.unset, + trigger: typing.Union[MetaOapg.properties.trigger, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'alert': + return super().__new__( + cls, + *_args, + execution=execution, + condition=condition, + interval=interval, + trigger=trigger, + _configuration=_configuration, + **kwargs, + ) + areRelationsValid = schemas.BoolSchema + + + class dashboardTabularExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['DashboardTabularExportRequestV2']: + return DashboardTabularExportRequestV2 + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'DashboardTabularExportRequestV2' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'DashboardTabularExportRequestV2': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'DashboardTabularExportRequestV2': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'DashboardTabularExportRequestV2', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dashboardTabularExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class description( + schemas.StrSchema + ): + pass + + + class details( + schemas.DictSchema + ): + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'details': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class evaluationMode( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SHARED(cls): + return cls("SHARED") + + @schemas.classproperty + def PER_RECIPIENT(cls): + return cls("PER_RECIPIENT") + + + class externalRecipients( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "email", + } + + class properties: + email = schemas.StrSchema + __annotations__ = { + "email": email, + } + + email: MetaOapg.properties.email + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["email", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["email", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + email: typing.Union[MetaOapg.properties.email, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + email=email, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'externalRecipients': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class imageExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['ImageExportRequest']: + return ImageExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'ImageExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'ImageExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'ImageExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'ImageExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'imageExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class metadata( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin + ): + + + class MetaOapg: + + class properties: + + + class visibleFilters( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['VisibleFilter']: + return VisibleFilter + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['VisibleFilter'], typing.List['VisibleFilter']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visibleFilters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'VisibleFilter': + return super().__getitem__(i) + widget = schemas.StrSchema + __annotations__ = { + "visibleFilters": visibleFilters, + "widget": widget, + } + additional_properties = schemas.AnyTypeSchema + + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visibleFilters"]) -> MetaOapg.properties.visibleFilters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widget"]) -> MetaOapg.properties.widget: ... + + @typing.overload + def __getitem__(self, name: str) -> MetaOapg.additional_properties: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["visibleFilters"], typing_extensions.Literal["widget"], str, ]): + # dict_instance[name] accessor + return super().__getitem__(name) + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visibleFilters"]) -> typing.Union[MetaOapg.properties.visibleFilters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widget"]) -> typing.Union[MetaOapg.properties.widget, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[MetaOapg.additional_properties, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["visibleFilters"], typing_extensions.Literal["widget"], str, ]): + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + visibleFilters: typing.Union[MetaOapg.properties.visibleFilters, list, tuple, schemas.Unset] = schemas.unset, + widget: typing.Union[MetaOapg.properties.widget, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + ) -> 'metadata': + return super().__new__( + cls, + *_args, + visibleFilters=visibleFilters, + widget=widget, + _configuration=_configuration, + **kwargs, + ) + + + class rawExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['RawExportAutomationRequest']: + return RawExportAutomationRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'RawExportAutomationRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'RawExportAutomationRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'RawExportAutomationRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'RawExportAutomationRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'rawExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class schedule( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "cron", + "timezone", + } + + class properties: + + + class cron( + schemas.StrSchema + ): + pass + cronDescription = schemas.StrSchema + firstRun = schemas.DateTimeSchema + + + class timezone( + schemas.StrSchema + ): + pass + __annotations__ = { + "cron": cron, + "cronDescription": cronDescription, + "firstRun": firstRun, + "timezone": timezone, + } + + cron: MetaOapg.properties.cron + timezone: MetaOapg.properties.timezone + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["cron"]) -> MetaOapg.properties.cron: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["cronDescription"]) -> MetaOapg.properties.cronDescription: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["firstRun"]) -> MetaOapg.properties.firstRun: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["timezone"]) -> MetaOapg.properties.timezone: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["cron", "cronDescription", "firstRun", "timezone", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["cron"]) -> MetaOapg.properties.cron: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["cronDescription"]) -> typing.Union[MetaOapg.properties.cronDescription, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["firstRun"]) -> typing.Union[MetaOapg.properties.firstRun, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["timezone"]) -> MetaOapg.properties.timezone: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["cron", "cronDescription", "firstRun", "timezone", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + cron: typing.Union[MetaOapg.properties.cron, str, ], + timezone: typing.Union[MetaOapg.properties.timezone, str, ], + cronDescription: typing.Union[MetaOapg.properties.cronDescription, str, schemas.Unset] = schemas.unset, + firstRun: typing.Union[MetaOapg.properties.firstRun, str, datetime, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'schedule': + return super().__new__( + cls, + *_args, + cron=cron, + timezone=timezone, + cronDescription=cronDescription, + firstRun=firstRun, + _configuration=_configuration, + **kwargs, + ) + + + class slidesExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['SlidesExportRequest']: + return SlidesExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'SlidesExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'SlidesExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'SlidesExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'SlidesExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'slidesExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class state( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ACTIVE(cls): + return cls("ACTIVE") + + @schemas.classproperty + def PAUSED(cls): + return cls("PAUSED") + + + class tabularExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['TabularExportRequest']: + return TabularExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'TabularExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'TabularExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'TabularExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'TabularExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tabularExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + + + class visualExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['VisualExportRequest']: + return VisualExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'VisualExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'VisualExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'VisualExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'VisualExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visualExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "alert": alert, + "areRelationsValid": areRelationsValid, + "dashboardTabularExports": dashboardTabularExports, + "description": description, + "details": details, + "evaluationMode": evaluationMode, + "externalRecipients": externalRecipients, + "imageExports": imageExports, + "metadata": metadata, + "rawExports": rawExports, + "schedule": schedule, + "slidesExports": slidesExports, + "state": state, + "tabularExports": tabularExports, + "tags": tags, + "title": title, + "visualExports": visualExports, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["alert"]) -> MetaOapg.properties.alert: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardTabularExports"]) -> MetaOapg.properties.dashboardTabularExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["details"]) -> MetaOapg.properties.details: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["evaluationMode"]) -> MetaOapg.properties.evaluationMode: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["externalRecipients"]) -> MetaOapg.properties.externalRecipients: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["imageExports"]) -> MetaOapg.properties.imageExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metadata"]) -> MetaOapg.properties.metadata: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rawExports"]) -> MetaOapg.properties.rawExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["schedule"]) -> MetaOapg.properties.schedule: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["slidesExports"]) -> MetaOapg.properties.slidesExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["state"]) -> MetaOapg.properties.state: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tabularExports"]) -> MetaOapg.properties.tabularExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualExports"]) -> MetaOapg.properties.visualExports: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["alert", "areRelationsValid", "dashboardTabularExports", "description", "details", "evaluationMode", "externalRecipients", "imageExports", "metadata", "rawExports", "schedule", "slidesExports", "state", "tabularExports", "tags", "title", "visualExports", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["alert"]) -> typing.Union[MetaOapg.properties.alert, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardTabularExports"]) -> typing.Union[MetaOapg.properties.dashboardTabularExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["details"]) -> typing.Union[MetaOapg.properties.details, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["evaluationMode"]) -> typing.Union[MetaOapg.properties.evaluationMode, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["externalRecipients"]) -> typing.Union[MetaOapg.properties.externalRecipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["imageExports"]) -> typing.Union[MetaOapg.properties.imageExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metadata"]) -> typing.Union[MetaOapg.properties.metadata, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rawExports"]) -> typing.Union[MetaOapg.properties.rawExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["schedule"]) -> typing.Union[MetaOapg.properties.schedule, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["slidesExports"]) -> typing.Union[MetaOapg.properties.slidesExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["state"]) -> typing.Union[MetaOapg.properties.state, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tabularExports"]) -> typing.Union[MetaOapg.properties.tabularExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualExports"]) -> typing.Union[MetaOapg.properties.visualExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["alert", "areRelationsValid", "dashboardTabularExports", "description", "details", "evaluationMode", "externalRecipients", "imageExports", "metadata", "rawExports", "schedule", "slidesExports", "state", "tabularExports", "tags", "title", "visualExports", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + alert: typing.Union[MetaOapg.properties.alert, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + dashboardTabularExports: typing.Union[MetaOapg.properties.dashboardTabularExports, list, tuple, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + details: typing.Union[MetaOapg.properties.details, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + evaluationMode: typing.Union[MetaOapg.properties.evaluationMode, str, schemas.Unset] = schemas.unset, + externalRecipients: typing.Union[MetaOapg.properties.externalRecipients, list, tuple, schemas.Unset] = schemas.unset, + imageExports: typing.Union[MetaOapg.properties.imageExports, list, tuple, schemas.Unset] = schemas.unset, + metadata: typing.Union[MetaOapg.properties.metadata, dict, frozendict.frozendict, None, schemas.Unset] = schemas.unset, + rawExports: typing.Union[MetaOapg.properties.rawExports, list, tuple, schemas.Unset] = schemas.unset, + schedule: typing.Union[MetaOapg.properties.schedule, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + slidesExports: typing.Union[MetaOapg.properties.slidesExports, list, tuple, schemas.Unset] = schemas.unset, + state: typing.Union[MetaOapg.properties.state, str, schemas.Unset] = schemas.unset, + tabularExports: typing.Union[MetaOapg.properties.tabularExports, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + visualExports: typing.Union[MetaOapg.properties.visualExports, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + alert=alert, + areRelationsValid=areRelationsValid, + dashboardTabularExports=dashboardTabularExports, + description=description, + details=details, + evaluationMode=evaluationMode, + externalRecipients=externalRecipients, + imageExports=imageExports, + metadata=metadata, + rawExports=rawExports, + schedule=schedule, + slidesExports=slidesExports, + state=state, + tabularExports=tabularExports, + tags=tags, + title=title, + visualExports=visualExports, + _configuration=_configuration, + **kwargs, + ) + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class analyticalDashboard( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAnalyticalDashboardToOneLinkage']: + return JsonApiAnalyticalDashboardToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAnalyticalDashboardToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAnalyticalDashboardToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'analyticalDashboard': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class exportDefinitions( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiExportDefinitionToManyLinkage']: + return JsonApiExportDefinitionToManyLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiExportDefinitionToManyLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportDefinitionToManyLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportDefinitionToManyLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiExportDefinitionToManyLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'exportDefinitions': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class notificationChannel( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiNotificationChannelToOneLinkage']: + return JsonApiNotificationChannelToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiNotificationChannelToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiNotificationChannelToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'notificationChannel': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class recipients( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserToManyLinkage']: + return JsonApiUserToManyLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserToManyLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToManyLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToManyLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserToManyLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'recipients': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "analyticalDashboard": analyticalDashboard, + "exportDefinitions": exportDefinitions, + "notificationChannel": notificationChannel, + "recipients": recipients, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> MetaOapg.properties.analyticalDashboard: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["exportDefinitions"]) -> MetaOapg.properties.exportDefinitions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["notificationChannel"]) -> MetaOapg.properties.notificationChannel: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["recipients"]) -> MetaOapg.properties.recipients: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "exportDefinitions", "notificationChannel", "recipients", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union[MetaOapg.properties.analyticalDashboard, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["exportDefinitions"]) -> typing.Union[MetaOapg.properties.exportDefinitions, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["notificationChannel"]) -> typing.Union[MetaOapg.properties.notificationChannel, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["recipients"]) -> typing.Union[MetaOapg.properties.recipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "exportDefinitions", "notificationChannel", "recipients", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + analyticalDashboard: typing.Union[MetaOapg.properties.analyticalDashboard, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + exportDefinitions: typing.Union[MetaOapg.properties.exportDefinitions, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + notificationChannel: typing.Union[MetaOapg.properties.notificationChannel, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + recipients: typing.Union[MetaOapg.properties.recipients, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + analyticalDashboard=analyticalDashboard, + exportDefinitions=exportDefinitions, + notificationChannel=notificationChannel, + recipients=recipients, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + "relationships": relationships, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAutomationPatch': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.alert_afm import AlertAfm +from gooddata_api_client.model.alert_condition import AlertCondition +from gooddata_api_client.model.dashboard_tabular_export_request_v2 import DashboardTabularExportRequestV2 +from gooddata_api_client.model.image_export_request import ImageExportRequest +from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.model.json_api_export_definition_to_many_linkage import JsonApiExportDefinitionToManyLinkage +from gooddata_api_client.model.json_api_notification_channel_to_one_linkage import JsonApiNotificationChannelToOneLinkage +from gooddata_api_client.model.json_api_user_to_many_linkage import JsonApiUserToManyLinkage +from gooddata_api_client.model.raw_export_automation_request import RawExportAutomationRequest +from gooddata_api_client.model.slides_export_request import SlidesExportRequest +from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.model.visible_filter import VisibleFilter +from gooddata_api_client.model.visual_export_request import VisualExportRequest diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_automation_patch_document.pyi new file mode 100644 index 000000000..90f5d1f97 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAutomationPatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAutomationPatch']: + return JsonApiAutomationPatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiAutomationPatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAutomationPatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAutomationPatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAutomationPatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAutomationPatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_automation_patch import JsonApiAutomationPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_linkage.pyi new file mode 100644 index 000000000..e296b1ea7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_linkage.pyi @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAutomationResultLinkage( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + The \"type\" and \"id\" to non-empty members. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def AUTOMATION_RESULT(cls): + return cls("automationResult") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAutomationResultLinkage': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out.pyi new file mode 100644 index 000000000..846885782 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out.pyi @@ -0,0 +1,351 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAutomationResultOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of automationResult entity. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "executedAt", + "status", + } + + class properties: + + + class errorMessage( + schemas.StrSchema + ): + pass + executedAt = schemas.DateTimeSchema + + + class status( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SUCCESS(cls): + return cls("SUCCESS") + + @schemas.classproperty + def FAILED(cls): + return cls("FAILED") + + + class traceId( + schemas.StrSchema + ): + pass + __annotations__ = { + "errorMessage": errorMessage, + "executedAt": executedAt, + "status": status, + "traceId": traceId, + } + + executedAt: MetaOapg.properties.executedAt + status: MetaOapg.properties.status + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["errorMessage"]) -> MetaOapg.properties.errorMessage: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["executedAt"]) -> MetaOapg.properties.executedAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["traceId"]) -> MetaOapg.properties.traceId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["errorMessage", "executedAt", "status", "traceId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["errorMessage"]) -> typing.Union[MetaOapg.properties.errorMessage, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["executedAt"]) -> MetaOapg.properties.executedAt: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["traceId"]) -> typing.Union[MetaOapg.properties.traceId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["errorMessage", "executedAt", "status", "traceId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + executedAt: typing.Union[MetaOapg.properties.executedAt, str, datetime, ], + status: typing.Union[MetaOapg.properties.status, str, ], + errorMessage: typing.Union[MetaOapg.properties.errorMessage, str, schemas.Unset] = schemas.unset, + traceId: typing.Union[MetaOapg.properties.traceId, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + executedAt=executedAt, + status=status, + errorMessage=errorMessage, + traceId=traceId, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def AUTOMATION_RESULT(cls): + return cls("automationResult") + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class automation( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAutomationToOneLinkage']: + return JsonApiAutomationToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAutomationToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAutomationToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAutomationToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAutomationToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'automation': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "automation": automation, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["automation"]) -> MetaOapg.properties.automation: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["automation", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["automation"]) -> typing.Union[MetaOapg.properties.automation, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["automation", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + automation: typing.Union[MetaOapg.properties.automation, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + automation=automation, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + "relationships": relationships, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAutomationResultOut': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_automation_to_one_linkage import JsonApiAutomationToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_list.pyi new file mode 100644 index 000000000..8742b762c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_list.pyi @@ -0,0 +1,226 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAutomationResultOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiAutomationResultOutWithLinks']: + return JsonApiAutomationResultOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiAutomationResultOutWithLinks'], typing.List['JsonApiAutomationResultOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiAutomationResultOutWithLinks': + return super().__getitem__(i) + + + class included( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiAutomationOutWithLinks']: + return JsonApiAutomationOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiAutomationOutWithLinks'], typing.List['JsonApiAutomationOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'included': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiAutomationOutWithLinks': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "included": included, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + included: typing.Union[MetaOapg.properties.included, list, tuple, schemas.Unset] = schemas.unset, + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAutomationResultOutList': + return super().__new__( + cls, + *_args, + data=data, + included=included, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_automation_out_with_links import JsonApiAutomationOutWithLinks +from gooddata_api_client.model.json_api_automation_result_out_with_links import JsonApiAutomationResultOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_with_links.pyi new file mode 100644 index 000000000..ee13591c7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAutomationResultOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiAutomationResultOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAutomationResultOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_automation_result_out import JsonApiAutomationResultOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_to_many_linkage.pyi new file mode 100644 index 000000000..f3e4c33ba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_result_to_many_linkage.pyi @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAutomationResultToManyLinkage( + schemas.ListSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + References to other resource objects in a to-many (\"relationship\"). Relationships can be specified by including a member in a resource's links object. + """ + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiAutomationResultLinkage']: + return JsonApiAutomationResultLinkage + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiAutomationResultLinkage'], typing.List['JsonApiAutomationResultLinkage']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'JsonApiAutomationResultToManyLinkage': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiAutomationResultLinkage': + return super().__getitem__(i) + +from gooddata_api_client.model.json_api_automation_result_linkage import JsonApiAutomationResultLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_to_one_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_automation_to_one_linkage.pyi new file mode 100644 index 000000000..0f7701eed --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_to_one_linkage.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiAutomationToOneLinkage( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + JsonApiAutomationLinkage, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiAutomationToOneLinkage': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_automation_linkage import JsonApiAutomationLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_in.pyi new file mode 100644 index 000000000..934cf114b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_in.pyi @@ -0,0 +1,225 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiCustomGeoCollectionIn( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of customGeoCollection entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def CUSTOM_GEO_COLLECTION(cls): + return cls("customGeoCollection") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class description( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'description': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class name( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'name': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + __annotations__ = { + "description": description, + "name": name, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["description", "name", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["description", "name", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + description: typing.Union[MetaOapg.properties.description, None, str, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, None, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + description=description, + name=name, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiCustomGeoCollectionIn': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_in_document.pyi new file mode 100644 index 000000000..cb724dd58 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_in_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiCustomGeoCollectionInDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiCustomGeoCollectionIn']: + return JsonApiCustomGeoCollectionIn + __annotations__ = { + "data": data, + } + + data: 'JsonApiCustomGeoCollectionIn' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiCustomGeoCollectionIn': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiCustomGeoCollectionIn': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiCustomGeoCollectionIn', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiCustomGeoCollectionInDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_custom_geo_collection_in import JsonApiCustomGeoCollectionIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out.pyi new file mode 100644 index 000000000..8b13df766 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out.pyi @@ -0,0 +1,225 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiCustomGeoCollectionOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of customGeoCollection entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def CUSTOM_GEO_COLLECTION(cls): + return cls("customGeoCollection") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class description( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'description': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class name( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'name': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + __annotations__ = { + "description": description, + "name": name, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["description", "name", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["description", "name", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + description: typing.Union[MetaOapg.properties.description, None, str, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, None, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + description=description, + name=name, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiCustomGeoCollectionOut': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_document.pyi new file mode 100644 index 000000000..34d5a95c9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_document.pyi @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiCustomGeoCollectionOutDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiCustomGeoCollectionOut']: + return JsonApiCustomGeoCollectionOut + + @staticmethod + def links() -> typing.Type['ObjectLinks']: + return ObjectLinks + __annotations__ = { + "data": data, + "links": links, + } + + data: 'JsonApiCustomGeoCollectionOut' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiCustomGeoCollectionOut': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiCustomGeoCollectionOut': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiCustomGeoCollectionOut', + links: typing.Union['ObjectLinks', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiCustomGeoCollectionOutDocument': + return super().__new__( + cls, + *_args, + data=data, + links=links, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_custom_geo_collection_out import JsonApiCustomGeoCollectionOut +from gooddata_api_client.model.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_list.pyi new file mode 100644 index 000000000..fa6dfbc58 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_list.pyi @@ -0,0 +1,190 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiCustomGeoCollectionOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiCustomGeoCollectionOutWithLinks']: + return JsonApiCustomGeoCollectionOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiCustomGeoCollectionOutWithLinks'], typing.List['JsonApiCustomGeoCollectionOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiCustomGeoCollectionOutWithLinks': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiCustomGeoCollectionOutList': + return super().__new__( + cls, + *_args, + data=data, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_custom_geo_collection_out_with_links import JsonApiCustomGeoCollectionOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_with_links.pyi new file mode 100644 index 000000000..48408a81b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiCustomGeoCollectionOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiCustomGeoCollectionOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiCustomGeoCollectionOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_custom_geo_collection_out import JsonApiCustomGeoCollectionOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_patch.pyi new file mode 100644 index 000000000..5d0da6f2f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_patch.pyi @@ -0,0 +1,225 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiCustomGeoCollectionPatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching customGeoCollection entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def CUSTOM_GEO_COLLECTION(cls): + return cls("customGeoCollection") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class description( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'description': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class name( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'name': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + __annotations__ = { + "description": description, + "name": name, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["description", "name", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["description", "name", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + description: typing.Union[MetaOapg.properties.description, None, str, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, None, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + description=description, + name=name, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiCustomGeoCollectionPatch': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_patch_document.pyi new file mode 100644 index 000000000..5cb983bbf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiCustomGeoCollectionPatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiCustomGeoCollectionPatch']: + return JsonApiCustomGeoCollectionPatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiCustomGeoCollectionPatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiCustomGeoCollectionPatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiCustomGeoCollectionPatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiCustomGeoCollectionPatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiCustomGeoCollectionPatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_custom_geo_collection_patch import JsonApiCustomGeoCollectionPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_relationships.py index 7552a6b35..bf516e528 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_relationships.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_relationships.py @@ -31,8 +31,8 @@ def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy - globals()['JsonApiAnalyticalDashboardOutRelationshipsCreatedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_certified_by import JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy + globals()['JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy class JsonApiDashboardPluginOutRelationships(ModelNormal): @@ -88,8 +88,8 @@ def openapi_types(): """ lazy_import() return { - 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 + 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy,), # noqa: E501 + 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy,), # noqa: E501 } @cached_property @@ -143,8 +143,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,) - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + created_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 + modified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -230,8 +230,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,) - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + created_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 + modified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_patch.pyi new file mode 100644 index 000000000..f1e919f7a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_patch.pyi @@ -0,0 +1,223 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiDatasetPatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching dataset entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DATASET(cls): + return cls("dataset") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class description( + schemas.StrSchema + ): + pass + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "description": description, + "tags": tags, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["description", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["description", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + description=description, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiDatasetPatch': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_patch_document.pyi new file mode 100644 index 000000000..8698c301d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiDatasetPatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiDatasetPatch']: + return JsonApiDatasetPatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiDatasetPatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetPatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiDatasetPatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiDatasetPatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiDatasetPatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_dataset_patch import JsonApiDatasetPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in.pyi new file mode 100644 index 000000000..9cbbe0c1c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in.pyi @@ -0,0 +1,468 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportDefinitionIn( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of exportDefinition entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def EXPORT_DEFINITION(cls): + return cls("exportDefinition") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + areRelationsValid = schemas.BoolSchema + + + class description( + schemas.StrSchema + ): + pass + + + class requestPayload( + schemas.ComposedBase, + schemas.DictSchema + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + VisualExportRequest, + TabularExportRequest, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'requestPayload': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "areRelationsValid": areRelationsValid, + "description": description, + "requestPayload": requestPayload, + "tags": tags, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> MetaOapg.properties.requestPayload: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "requestPayload", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> typing.Union[MetaOapg.properties.requestPayload, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "requestPayload", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + requestPayload: typing.Union[MetaOapg.properties.requestPayload, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + areRelationsValid=areRelationsValid, + description=description, + requestPayload=requestPayload, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class analyticalDashboard( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAnalyticalDashboardToOneLinkage']: + return JsonApiAnalyticalDashboardToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAnalyticalDashboardToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAnalyticalDashboardToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'analyticalDashboard': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class visualizationObject( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiVisualizationObjectToOneLinkage']: + return JsonApiVisualizationObjectToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiVisualizationObjectToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiVisualizationObjectToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'visualizationObject': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "analyticalDashboard": analyticalDashboard, + "visualizationObject": visualizationObject, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> MetaOapg.properties.analyticalDashboard: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualizationObject"]) -> MetaOapg.properties.visualizationObject: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "visualizationObject", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union[MetaOapg.properties.analyticalDashboard, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualizationObject"]) -> typing.Union[MetaOapg.properties.visualizationObject, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "visualizationObject", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + analyticalDashboard: typing.Union[MetaOapg.properties.analyticalDashboard, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + visualizationObject: typing.Union[MetaOapg.properties.visualizationObject, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + analyticalDashboard=analyticalDashboard, + visualizationObject=visualizationObject, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + "relationships": relationships, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportDefinitionIn': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.model.json_api_visualization_object_to_one_linkage import JsonApiVisualizationObjectToOneLinkage +from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.model.visual_export_request import VisualExportRequest diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_document.pyi new file mode 100644 index 000000000..127d00860 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportDefinitionInDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiExportDefinitionIn']: + return JsonApiExportDefinitionIn + __annotations__ = { + "data": data, + } + + data: 'JsonApiExportDefinitionIn' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportDefinitionIn': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportDefinitionIn': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiExportDefinitionIn', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportDefinitionInDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_export_definition_in import JsonApiExportDefinitionIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_linkage.pyi new file mode 100644 index 000000000..7c41cf69d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_linkage.pyi @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportDefinitionLinkage( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + The \"type\" and \"id\" to non-empty members. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def EXPORT_DEFINITION(cls): + return cls("exportDefinition") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportDefinitionLinkage': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out.pyi new file mode 100644 index 000000000..f6a37aedf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out.pyi @@ -0,0 +1,877 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportDefinitionOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of exportDefinition entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def EXPORT_DEFINITION(cls): + return cls("exportDefinition") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + areRelationsValid = schemas.BoolSchema + + + class createdAt( + schemas.DateTimeBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + format = 'date-time' + + + def __new__( + cls, + *_args: typing.Union[None, str, datetime, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'createdAt': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class description( + schemas.StrSchema + ): + pass + + + class modifiedAt( + schemas.DateTimeBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + format = 'date-time' + + + def __new__( + cls, + *_args: typing.Union[None, str, datetime, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'modifiedAt': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class requestPayload( + schemas.ComposedBase, + schemas.DictSchema + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + VisualExportRequest, + TabularExportRequest, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'requestPayload': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "areRelationsValid": areRelationsValid, + "createdAt": createdAt, + "description": description, + "modifiedAt": modifiedAt, + "requestPayload": requestPayload, + "tags": tags, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdAt"]) -> MetaOapg.properties.createdAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedAt"]) -> MetaOapg.properties.modifiedAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> MetaOapg.properties.requestPayload: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "createdAt", "description", "modifiedAt", "requestPayload", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdAt"]) -> typing.Union[MetaOapg.properties.createdAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedAt"]) -> typing.Union[MetaOapg.properties.modifiedAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> typing.Union[MetaOapg.properties.requestPayload, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "createdAt", "description", "modifiedAt", "requestPayload", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + createdAt: typing.Union[MetaOapg.properties.createdAt, None, str, datetime, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + modifiedAt: typing.Union[MetaOapg.properties.modifiedAt, None, str, datetime, schemas.Unset] = schemas.unset, + requestPayload: typing.Union[MetaOapg.properties.requestPayload, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + areRelationsValid=areRelationsValid, + createdAt=createdAt, + description=description, + modifiedAt=modifiedAt, + requestPayload=requestPayload, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class origin( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "originType", + "originId", + } + + class properties: + originId = schemas.StrSchema + + + class originType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") + + @schemas.classproperty + def PARENT(cls): + return cls("PARENT") + __annotations__ = { + "originId": originId, + "originType": originType, + } + + originType: MetaOapg.properties.originType + originId: MetaOapg.properties.originId + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + originType: typing.Union[MetaOapg.properties.originType, str, ], + originId: typing.Union[MetaOapg.properties.originId, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'origin': + return super().__new__( + cls, + *_args, + originType=originType, + originId=originId, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "origin": origin, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["origin"]) -> MetaOapg.properties.origin: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["origin"]) -> typing.Union[MetaOapg.properties.origin, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + origin: typing.Union[MetaOapg.properties.origin, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + origin=origin, + _configuration=_configuration, + **kwargs, + ) + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class analyticalDashboard( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAnalyticalDashboardToOneLinkage']: + return JsonApiAnalyticalDashboardToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAnalyticalDashboardToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAnalyticalDashboardToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'analyticalDashboard': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class automation( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAutomationToOneLinkage']: + return JsonApiAutomationToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAutomationToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAutomationToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAutomationToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAutomationToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'automation': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class createdBy( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserIdentifierToOneLinkage']: + return JsonApiUserIdentifierToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserIdentifierToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserIdentifierToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'createdBy': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class modifiedBy( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserIdentifierToOneLinkage']: + return JsonApiUserIdentifierToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserIdentifierToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserIdentifierToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'modifiedBy': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class visualizationObject( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiVisualizationObjectToOneLinkage']: + return JsonApiVisualizationObjectToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiVisualizationObjectToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiVisualizationObjectToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'visualizationObject': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "analyticalDashboard": analyticalDashboard, + "automation": automation, + "createdBy": createdBy, + "modifiedBy": modifiedBy, + "visualizationObject": visualizationObject, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> MetaOapg.properties.analyticalDashboard: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["automation"]) -> MetaOapg.properties.automation: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdBy"]) -> MetaOapg.properties.createdBy: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedBy"]) -> MetaOapg.properties.modifiedBy: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualizationObject"]) -> MetaOapg.properties.visualizationObject: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "automation", "createdBy", "modifiedBy", "visualizationObject", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union[MetaOapg.properties.analyticalDashboard, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["automation"]) -> typing.Union[MetaOapg.properties.automation, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdBy"]) -> typing.Union[MetaOapg.properties.createdBy, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedBy"]) -> typing.Union[MetaOapg.properties.modifiedBy, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualizationObject"]) -> typing.Union[MetaOapg.properties.visualizationObject, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "automation", "createdBy", "modifiedBy", "visualizationObject", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + analyticalDashboard: typing.Union[MetaOapg.properties.analyticalDashboard, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + automation: typing.Union[MetaOapg.properties.automation, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + createdBy: typing.Union[MetaOapg.properties.createdBy, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + modifiedBy: typing.Union[MetaOapg.properties.modifiedBy, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + visualizationObject: typing.Union[MetaOapg.properties.visualizationObject, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + analyticalDashboard=analyticalDashboard, + automation=automation, + createdBy=createdBy, + modifiedBy=modifiedBy, + visualizationObject=visualizationObject, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + "meta": meta, + "relationships": relationships, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "meta", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportDefinitionOut': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + meta=meta, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.model.json_api_automation_to_one_linkage import JsonApiAutomationToOneLinkage +from gooddata_api_client.model.json_api_user_identifier_to_one_linkage import JsonApiUserIdentifierToOneLinkage +from gooddata_api_client.model.json_api_visualization_object_to_one_linkage import JsonApiVisualizationObjectToOneLinkage +from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.model.visual_export_request import VisualExportRequest diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_document.pyi new file mode 100644 index 000000000..119215205 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_document.pyi @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportDefinitionOutDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiExportDefinitionOut']: + return JsonApiExportDefinitionOut + + + class included( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiExportDefinitionOutIncludes']: + return JsonApiExportDefinitionOutIncludes + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiExportDefinitionOutIncludes'], typing.List['JsonApiExportDefinitionOutIncludes']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'included': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiExportDefinitionOutIncludes': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ObjectLinks']: + return ObjectLinks + __annotations__ = { + "data": data, + "included": included, + "links": links, + } + + data: 'JsonApiExportDefinitionOut' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportDefinitionOut': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportDefinitionOut': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiExportDefinitionOut', + included: typing.Union[MetaOapg.properties.included, list, tuple, schemas.Unset] = schemas.unset, + links: typing.Union['ObjectLinks', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportDefinitionOutDocument': + return super().__new__( + cls, + *_args, + data=data, + included=included, + links=links, + _configuration=_configuration, + **kwargs, + ) + +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 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_includes.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_includes.pyi new file mode 100644 index 000000000..412ac4d8a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_includes.pyi @@ -0,0 +1,73 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportDefinitionOutIncludes( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + JsonApiVisualizationObjectOutWithLinks, + JsonApiAnalyticalDashboardOutWithLinks, + JsonApiAutomationOutWithLinks, + JsonApiUserIdentifierOutWithLinks, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportDefinitionOutIncludes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks +from gooddata_api_client.model.json_api_automation_out_with_links import JsonApiAutomationOutWithLinks +from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks +from gooddata_api_client.model.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_list.pyi new file mode 100644 index 000000000..d296976d3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_list.pyi @@ -0,0 +1,226 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportDefinitionOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiExportDefinitionOutWithLinks']: + return JsonApiExportDefinitionOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiExportDefinitionOutWithLinks'], typing.List['JsonApiExportDefinitionOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiExportDefinitionOutWithLinks': + return super().__getitem__(i) + + + class included( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiExportDefinitionOutIncludes']: + return JsonApiExportDefinitionOutIncludes + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiExportDefinitionOutIncludes'], typing.List['JsonApiExportDefinitionOutIncludes']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'included': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiExportDefinitionOutIncludes': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "included": included, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + included: typing.Union[MetaOapg.properties.included, list, tuple, schemas.Unset] = schemas.unset, + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportDefinitionOutList': + return super().__new__( + cls, + *_args, + data=data, + included=included, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_export_definition_out_includes import JsonApiExportDefinitionOutIncludes +from gooddata_api_client.model.json_api_export_definition_out_with_links import JsonApiExportDefinitionOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_relationships.py index 45d3e3952..99082e024 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_relationships.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_relationships.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_certified_by import JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy from gooddata_api_client.model.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard from gooddata_api_client.model.json_api_automation_result_out_relationships_automation import JsonApiAutomationResultOutRelationshipsAutomation from gooddata_api_client.model.json_api_export_definition_in_relationships_visualization_object import JsonApiExportDefinitionInRelationshipsVisualizationObject - globals()['JsonApiAnalyticalDashboardOutRelationshipsCreatedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy + globals()['JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy globals()['JsonApiAutomationInRelationshipsAnalyticalDashboard'] = JsonApiAutomationInRelationshipsAnalyticalDashboard globals()['JsonApiAutomationResultOutRelationshipsAutomation'] = JsonApiAutomationResultOutRelationshipsAutomation globals()['JsonApiExportDefinitionInRelationshipsVisualizationObject'] = JsonApiExportDefinitionInRelationshipsVisualizationObject @@ -96,8 +96,8 @@ def openapi_types(): return { 'analytical_dashboard': (JsonApiAutomationInRelationshipsAnalyticalDashboard,), # noqa: E501 'automation': (JsonApiAutomationResultOutRelationshipsAutomation,), # noqa: E501 - 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 - 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 + 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy,), # noqa: E501 + 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy,), # noqa: E501 'visualization_object': (JsonApiExportDefinitionInRelationshipsVisualizationObject,), # noqa: E501 } @@ -157,8 +157,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 automation (JsonApiAutomationResultOutRelationshipsAutomation): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + created_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 + modified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 visualization_object (JsonApiExportDefinitionInRelationshipsVisualizationObject): [optional] # noqa: E501 """ @@ -247,8 +247,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 automation (JsonApiAutomationResultOutRelationshipsAutomation): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + created_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 + modified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 visualization_object (JsonApiExportDefinitionInRelationshipsVisualizationObject): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_with_links.pyi new file mode 100644 index 000000000..8168c4031 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportDefinitionOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiExportDefinitionOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportDefinitionOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_export_definition_out import JsonApiExportDefinitionOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_patch.pyi new file mode 100644 index 000000000..315e90963 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_patch.pyi @@ -0,0 +1,468 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportDefinitionPatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching exportDefinition entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def EXPORT_DEFINITION(cls): + return cls("exportDefinition") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + areRelationsValid = schemas.BoolSchema + + + class description( + schemas.StrSchema + ): + pass + + + class requestPayload( + schemas.ComposedBase, + schemas.DictSchema + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + VisualExportRequest, + TabularExportRequest, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'requestPayload': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "areRelationsValid": areRelationsValid, + "description": description, + "requestPayload": requestPayload, + "tags": tags, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> MetaOapg.properties.requestPayload: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "requestPayload", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> typing.Union[MetaOapg.properties.requestPayload, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "requestPayload", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + requestPayload: typing.Union[MetaOapg.properties.requestPayload, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + areRelationsValid=areRelationsValid, + description=description, + requestPayload=requestPayload, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class analyticalDashboard( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAnalyticalDashboardToOneLinkage']: + return JsonApiAnalyticalDashboardToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAnalyticalDashboardToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAnalyticalDashboardToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'analyticalDashboard': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class visualizationObject( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiVisualizationObjectToOneLinkage']: + return JsonApiVisualizationObjectToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiVisualizationObjectToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiVisualizationObjectToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'visualizationObject': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "analyticalDashboard": analyticalDashboard, + "visualizationObject": visualizationObject, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> MetaOapg.properties.analyticalDashboard: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualizationObject"]) -> MetaOapg.properties.visualizationObject: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "visualizationObject", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union[MetaOapg.properties.analyticalDashboard, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualizationObject"]) -> typing.Union[MetaOapg.properties.visualizationObject, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "visualizationObject", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + analyticalDashboard: typing.Union[MetaOapg.properties.analyticalDashboard, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + visualizationObject: typing.Union[MetaOapg.properties.visualizationObject, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + analyticalDashboard=analyticalDashboard, + visualizationObject=visualizationObject, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + "relationships": relationships, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportDefinitionPatch': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.model.json_api_visualization_object_to_one_linkage import JsonApiVisualizationObjectToOneLinkage +from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.model.visual_export_request import VisualExportRequest diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_patch_document.pyi new file mode 100644 index 000000000..63a1098d4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportDefinitionPatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiExportDefinitionPatch']: + return JsonApiExportDefinitionPatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiExportDefinitionPatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportDefinitionPatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportDefinitionPatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiExportDefinitionPatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportDefinitionPatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_export_definition_patch import JsonApiExportDefinitionPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_post_optional_id.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_post_optional_id.pyi new file mode 100644 index 000000000..51cc5e5df --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_post_optional_id.pyi @@ -0,0 +1,466 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportDefinitionPostOptionalId( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of exportDefinition entity. + """ + + + class MetaOapg: + required = { + "type", + } + + class properties: + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def EXPORT_DEFINITION(cls): + return cls("exportDefinition") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + areRelationsValid = schemas.BoolSchema + + + class description( + schemas.StrSchema + ): + pass + + + class requestPayload( + schemas.ComposedBase, + schemas.DictSchema + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + VisualExportRequest, + TabularExportRequest, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'requestPayload': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "areRelationsValid": areRelationsValid, + "description": description, + "requestPayload": requestPayload, + "tags": tags, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> MetaOapg.properties.requestPayload: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "requestPayload", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> typing.Union[MetaOapg.properties.requestPayload, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "requestPayload", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + requestPayload: typing.Union[MetaOapg.properties.requestPayload, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + areRelationsValid=areRelationsValid, + description=description, + requestPayload=requestPayload, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class analyticalDashboard( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAnalyticalDashboardToOneLinkage']: + return JsonApiAnalyticalDashboardToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAnalyticalDashboardToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAnalyticalDashboardToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'analyticalDashboard': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class visualizationObject( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiVisualizationObjectToOneLinkage']: + return JsonApiVisualizationObjectToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiVisualizationObjectToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiVisualizationObjectToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiVisualizationObjectToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'visualizationObject': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "analyticalDashboard": analyticalDashboard, + "visualizationObject": visualizationObject, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> MetaOapg.properties.analyticalDashboard: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualizationObject"]) -> MetaOapg.properties.visualizationObject: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "visualizationObject", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union[MetaOapg.properties.analyticalDashboard, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualizationObject"]) -> typing.Union[MetaOapg.properties.visualizationObject, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "visualizationObject", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + analyticalDashboard: typing.Union[MetaOapg.properties.analyticalDashboard, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + visualizationObject: typing.Union[MetaOapg.properties.visualizationObject, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + analyticalDashboard=analyticalDashboard, + visualizationObject=visualizationObject, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "type": type, + "attributes": attributes, + "id": id, + "relationships": relationships, + } + + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["type", "attributes", "id", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> typing.Union[MetaOapg.properties.id, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["type", "attributes", "id", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + id: typing.Union[MetaOapg.properties.id, str, schemas.Unset] = schemas.unset, + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportDefinitionPostOptionalId': + return super().__new__( + cls, + *_args, + type=type, + attributes=attributes, + id=id, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.model.json_api_visualization_object_to_one_linkage import JsonApiVisualizationObjectToOneLinkage +from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.model.visual_export_request import VisualExportRequest diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_post_optional_id_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_post_optional_id_document.pyi new file mode 100644 index 000000000..99c191080 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_post_optional_id_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportDefinitionPostOptionalIdDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiExportDefinitionPostOptionalId']: + return JsonApiExportDefinitionPostOptionalId + __annotations__ = { + "data": data, + } + + data: 'JsonApiExportDefinitionPostOptionalId' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportDefinitionPostOptionalId': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportDefinitionPostOptionalId': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiExportDefinitionPostOptionalId', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportDefinitionPostOptionalIdDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_export_definition_post_optional_id import JsonApiExportDefinitionPostOptionalId diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_to_many_linkage.pyi new file mode 100644 index 000000000..996cb3082 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_to_many_linkage.pyi @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportDefinitionToManyLinkage( + schemas.ListSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + References to other resource objects in a to-many (\"relationship\"). Relationships can be specified by including a member in a resource's links object. + """ + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiExportDefinitionLinkage']: + return JsonApiExportDefinitionLinkage + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiExportDefinitionLinkage'], typing.List['JsonApiExportDefinitionLinkage']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'JsonApiExportDefinitionToManyLinkage': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiExportDefinitionLinkage': + return super().__getitem__(i) + +from gooddata_api_client.model.json_api_export_definition_linkage import JsonApiExportDefinitionLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in.pyi new file mode 100644 index 000000000..81f7fad5b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in.pyi @@ -0,0 +1,455 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportTemplateIn( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of exportTemplate entity. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "name", + } + + class properties: + + + class dashboardSlidesTemplate( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin + ): + + + class MetaOapg: + required = { + "appliedOn", + } + + class properties: + + + class appliedOn( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PDF(cls): + return cls("PDF") + + @schemas.classproperty + def PPTX(cls): + return cls("PPTX") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'appliedOn': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def contentSlide() -> typing.Type['ContentSlideTemplate']: + return ContentSlideTemplate + + @staticmethod + def coverSlide() -> typing.Type['CoverSlideTemplate']: + return CoverSlideTemplate + + @staticmethod + def introSlide() -> typing.Type['IntroSlideTemplate']: + return IntroSlideTemplate + + @staticmethod + def sectionSlide() -> typing.Type['SectionSlideTemplate']: + return SectionSlideTemplate + __annotations__ = { + "appliedOn": appliedOn, + "contentSlide": contentSlide, + "coverSlide": coverSlide, + "introSlide": introSlide, + "sectionSlide": sectionSlide, + } + + + appliedOn: MetaOapg.properties.appliedOn + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["contentSlide"]) -> 'ContentSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["coverSlide"]) -> 'CoverSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["introSlide"]) -> 'IntroSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sectionSlide"]) -> 'SectionSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", "coverSlide", "introSlide", "sectionSlide", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["contentSlide"]) -> typing.Union['ContentSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["coverSlide"]) -> typing.Union['CoverSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["introSlide"]) -> typing.Union['IntroSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sectionSlide"]) -> typing.Union['SectionSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", "coverSlide", "introSlide", "sectionSlide", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + contentSlide: typing.Union['ContentSlideTemplate', schemas.Unset] = schemas.unset, + coverSlide: typing.Union['CoverSlideTemplate', schemas.Unset] = schemas.unset, + introSlide: typing.Union['IntroSlideTemplate', schemas.Unset] = schemas.unset, + sectionSlide: typing.Union['SectionSlideTemplate', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'dashboardSlidesTemplate': + return super().__new__( + cls, + *_args, + contentSlide=contentSlide, + coverSlide=coverSlide, + introSlide=introSlide, + sectionSlide=sectionSlide, + _configuration=_configuration, + **kwargs, + ) + + + class name( + schemas.StrSchema + ): + pass + + + class widgetSlidesTemplate( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin + ): + + + class MetaOapg: + required = { + "appliedOn", + } + + class properties: + + + class appliedOn( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PDF(cls): + return cls("PDF") + + @schemas.classproperty + def PPTX(cls): + return cls("PPTX") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'appliedOn': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def contentSlide() -> typing.Type['ContentSlideTemplate']: + return ContentSlideTemplate + __annotations__ = { + "appliedOn": appliedOn, + "contentSlide": contentSlide, + } + + + appliedOn: MetaOapg.properties.appliedOn + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["contentSlide"]) -> 'ContentSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["contentSlide"]) -> typing.Union['ContentSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + contentSlide: typing.Union['ContentSlideTemplate', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'widgetSlidesTemplate': + return super().__new__( + cls, + *_args, + contentSlide=contentSlide, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "dashboardSlidesTemplate": dashboardSlidesTemplate, + "name": name, + "widgetSlidesTemplate": widgetSlidesTemplate, + } + + name: MetaOapg.properties.name + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardSlidesTemplate"]) -> MetaOapg.properties.dashboardSlidesTemplate: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetSlidesTemplate"]) -> MetaOapg.properties.widgetSlidesTemplate: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dashboardSlidesTemplate", "name", "widgetSlidesTemplate", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardSlidesTemplate"]) -> typing.Union[MetaOapg.properties.dashboardSlidesTemplate, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetSlidesTemplate"]) -> typing.Union[MetaOapg.properties.widgetSlidesTemplate, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dashboardSlidesTemplate", "name", "widgetSlidesTemplate", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + name: typing.Union[MetaOapg.properties.name, str, ], + dashboardSlidesTemplate: typing.Union[MetaOapg.properties.dashboardSlidesTemplate, dict, frozendict.frozendict, None, schemas.Unset] = schemas.unset, + widgetSlidesTemplate: typing.Union[MetaOapg.properties.widgetSlidesTemplate, dict, frozendict.frozendict, None, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + name=name, + dashboardSlidesTemplate=dashboardSlidesTemplate, + widgetSlidesTemplate=widgetSlidesTemplate, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def EXPORT_TEMPLATE(cls): + return cls("exportTemplate") + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportTemplateIn': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.content_slide_template import ContentSlideTemplate +from gooddata_api_client.model.cover_slide_template import CoverSlideTemplate +from gooddata_api_client.model.intro_slide_template import IntroSlideTemplate +from gooddata_api_client.model.section_slide_template import SectionSlideTemplate diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_document.pyi new file mode 100644 index 000000000..d1849cb8f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_in_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportTemplateInDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiExportTemplateIn']: + return JsonApiExportTemplateIn + __annotations__ = { + "data": data, + } + + data: 'JsonApiExportTemplateIn' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportTemplateIn': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportTemplateIn': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiExportTemplateIn', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportTemplateInDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_export_template_in import JsonApiExportTemplateIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out.pyi new file mode 100644 index 000000000..8dc9549d6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out.pyi @@ -0,0 +1,455 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportTemplateOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of exportTemplate entity. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "name", + } + + class properties: + + + class dashboardSlidesTemplate( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin + ): + + + class MetaOapg: + required = { + "appliedOn", + } + + class properties: + + + class appliedOn( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PDF(cls): + return cls("PDF") + + @schemas.classproperty + def PPTX(cls): + return cls("PPTX") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'appliedOn': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def contentSlide() -> typing.Type['ContentSlideTemplate']: + return ContentSlideTemplate + + @staticmethod + def coverSlide() -> typing.Type['CoverSlideTemplate']: + return CoverSlideTemplate + + @staticmethod + def introSlide() -> typing.Type['IntroSlideTemplate']: + return IntroSlideTemplate + + @staticmethod + def sectionSlide() -> typing.Type['SectionSlideTemplate']: + return SectionSlideTemplate + __annotations__ = { + "appliedOn": appliedOn, + "contentSlide": contentSlide, + "coverSlide": coverSlide, + "introSlide": introSlide, + "sectionSlide": sectionSlide, + } + + + appliedOn: MetaOapg.properties.appliedOn + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["contentSlide"]) -> 'ContentSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["coverSlide"]) -> 'CoverSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["introSlide"]) -> 'IntroSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sectionSlide"]) -> 'SectionSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", "coverSlide", "introSlide", "sectionSlide", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["contentSlide"]) -> typing.Union['ContentSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["coverSlide"]) -> typing.Union['CoverSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["introSlide"]) -> typing.Union['IntroSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sectionSlide"]) -> typing.Union['SectionSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", "coverSlide", "introSlide", "sectionSlide", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + contentSlide: typing.Union['ContentSlideTemplate', schemas.Unset] = schemas.unset, + coverSlide: typing.Union['CoverSlideTemplate', schemas.Unset] = schemas.unset, + introSlide: typing.Union['IntroSlideTemplate', schemas.Unset] = schemas.unset, + sectionSlide: typing.Union['SectionSlideTemplate', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'dashboardSlidesTemplate': + return super().__new__( + cls, + *_args, + contentSlide=contentSlide, + coverSlide=coverSlide, + introSlide=introSlide, + sectionSlide=sectionSlide, + _configuration=_configuration, + **kwargs, + ) + + + class name( + schemas.StrSchema + ): + pass + + + class widgetSlidesTemplate( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin + ): + + + class MetaOapg: + required = { + "appliedOn", + } + + class properties: + + + class appliedOn( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PDF(cls): + return cls("PDF") + + @schemas.classproperty + def PPTX(cls): + return cls("PPTX") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'appliedOn': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def contentSlide() -> typing.Type['ContentSlideTemplate']: + return ContentSlideTemplate + __annotations__ = { + "appliedOn": appliedOn, + "contentSlide": contentSlide, + } + + + appliedOn: MetaOapg.properties.appliedOn + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["contentSlide"]) -> 'ContentSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["contentSlide"]) -> typing.Union['ContentSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + contentSlide: typing.Union['ContentSlideTemplate', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'widgetSlidesTemplate': + return super().__new__( + cls, + *_args, + contentSlide=contentSlide, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "dashboardSlidesTemplate": dashboardSlidesTemplate, + "name": name, + "widgetSlidesTemplate": widgetSlidesTemplate, + } + + name: MetaOapg.properties.name + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardSlidesTemplate"]) -> MetaOapg.properties.dashboardSlidesTemplate: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetSlidesTemplate"]) -> MetaOapg.properties.widgetSlidesTemplate: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dashboardSlidesTemplate", "name", "widgetSlidesTemplate", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardSlidesTemplate"]) -> typing.Union[MetaOapg.properties.dashboardSlidesTemplate, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetSlidesTemplate"]) -> typing.Union[MetaOapg.properties.widgetSlidesTemplate, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dashboardSlidesTemplate", "name", "widgetSlidesTemplate", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + name: typing.Union[MetaOapg.properties.name, str, ], + dashboardSlidesTemplate: typing.Union[MetaOapg.properties.dashboardSlidesTemplate, dict, frozendict.frozendict, None, schemas.Unset] = schemas.unset, + widgetSlidesTemplate: typing.Union[MetaOapg.properties.widgetSlidesTemplate, dict, frozendict.frozendict, None, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + name=name, + dashboardSlidesTemplate=dashboardSlidesTemplate, + widgetSlidesTemplate=widgetSlidesTemplate, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def EXPORT_TEMPLATE(cls): + return cls("exportTemplate") + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportTemplateOut': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.content_slide_template import ContentSlideTemplate +from gooddata_api_client.model.cover_slide_template import CoverSlideTemplate +from gooddata_api_client.model.intro_slide_template import IntroSlideTemplate +from gooddata_api_client.model.section_slide_template import SectionSlideTemplate diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_document.pyi new file mode 100644 index 000000000..f580859d0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_document.pyi @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportTemplateOutDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiExportTemplateOut']: + return JsonApiExportTemplateOut + + @staticmethod + def links() -> typing.Type['ObjectLinks']: + return ObjectLinks + __annotations__ = { + "data": data, + "links": links, + } + + data: 'JsonApiExportTemplateOut' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportTemplateOut': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportTemplateOut': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiExportTemplateOut', + links: typing.Union['ObjectLinks', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportTemplateOutDocument': + return super().__new__( + cls, + *_args, + data=data, + links=links, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_export_template_out import JsonApiExportTemplateOut +from gooddata_api_client.model.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_list.pyi new file mode 100644 index 000000000..66ea3f5b4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_list.pyi @@ -0,0 +1,190 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportTemplateOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiExportTemplateOutWithLinks']: + return JsonApiExportTemplateOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiExportTemplateOutWithLinks'], typing.List['JsonApiExportTemplateOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiExportTemplateOutWithLinks': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportTemplateOutList': + return super().__new__( + cls, + *_args, + data=data, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_export_template_out_with_links import JsonApiExportTemplateOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_with_links.pyi new file mode 100644 index 000000000..1c5b9d88a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportTemplateOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiExportTemplateOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportTemplateOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_export_template_out import JsonApiExportTemplateOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch.pyi new file mode 100644 index 000000000..0c3242918 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch.pyi @@ -0,0 +1,450 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportTemplatePatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching exportTemplate entity. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class dashboardSlidesTemplate( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin + ): + + + class MetaOapg: + required = { + "appliedOn", + } + + class properties: + + + class appliedOn( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PDF(cls): + return cls("PDF") + + @schemas.classproperty + def PPTX(cls): + return cls("PPTX") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'appliedOn': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def contentSlide() -> typing.Type['ContentSlideTemplate']: + return ContentSlideTemplate + + @staticmethod + def coverSlide() -> typing.Type['CoverSlideTemplate']: + return CoverSlideTemplate + + @staticmethod + def introSlide() -> typing.Type['IntroSlideTemplate']: + return IntroSlideTemplate + + @staticmethod + def sectionSlide() -> typing.Type['SectionSlideTemplate']: + return SectionSlideTemplate + __annotations__ = { + "appliedOn": appliedOn, + "contentSlide": contentSlide, + "coverSlide": coverSlide, + "introSlide": introSlide, + "sectionSlide": sectionSlide, + } + + + appliedOn: MetaOapg.properties.appliedOn + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["contentSlide"]) -> 'ContentSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["coverSlide"]) -> 'CoverSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["introSlide"]) -> 'IntroSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sectionSlide"]) -> 'SectionSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", "coverSlide", "introSlide", "sectionSlide", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["contentSlide"]) -> typing.Union['ContentSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["coverSlide"]) -> typing.Union['CoverSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["introSlide"]) -> typing.Union['IntroSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sectionSlide"]) -> typing.Union['SectionSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", "coverSlide", "introSlide", "sectionSlide", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + contentSlide: typing.Union['ContentSlideTemplate', schemas.Unset] = schemas.unset, + coverSlide: typing.Union['CoverSlideTemplate', schemas.Unset] = schemas.unset, + introSlide: typing.Union['IntroSlideTemplate', schemas.Unset] = schemas.unset, + sectionSlide: typing.Union['SectionSlideTemplate', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'dashboardSlidesTemplate': + return super().__new__( + cls, + *_args, + contentSlide=contentSlide, + coverSlide=coverSlide, + introSlide=introSlide, + sectionSlide=sectionSlide, + _configuration=_configuration, + **kwargs, + ) + + + class name( + schemas.StrSchema + ): + pass + + + class widgetSlidesTemplate( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin + ): + + + class MetaOapg: + required = { + "appliedOn", + } + + class properties: + + + class appliedOn( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PDF(cls): + return cls("PDF") + + @schemas.classproperty + def PPTX(cls): + return cls("PPTX") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'appliedOn': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def contentSlide() -> typing.Type['ContentSlideTemplate']: + return ContentSlideTemplate + __annotations__ = { + "appliedOn": appliedOn, + "contentSlide": contentSlide, + } + + + appliedOn: MetaOapg.properties.appliedOn + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["contentSlide"]) -> 'ContentSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["contentSlide"]) -> typing.Union['ContentSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + contentSlide: typing.Union['ContentSlideTemplate', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'widgetSlidesTemplate': + return super().__new__( + cls, + *_args, + contentSlide=contentSlide, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "dashboardSlidesTemplate": dashboardSlidesTemplate, + "name": name, + "widgetSlidesTemplate": widgetSlidesTemplate, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardSlidesTemplate"]) -> MetaOapg.properties.dashboardSlidesTemplate: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetSlidesTemplate"]) -> MetaOapg.properties.widgetSlidesTemplate: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dashboardSlidesTemplate", "name", "widgetSlidesTemplate", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardSlidesTemplate"]) -> typing.Union[MetaOapg.properties.dashboardSlidesTemplate, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetSlidesTemplate"]) -> typing.Union[MetaOapg.properties.widgetSlidesTemplate, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dashboardSlidesTemplate", "name", "widgetSlidesTemplate", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + dashboardSlidesTemplate: typing.Union[MetaOapg.properties.dashboardSlidesTemplate, dict, frozendict.frozendict, None, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, str, schemas.Unset] = schemas.unset, + widgetSlidesTemplate: typing.Union[MetaOapg.properties.widgetSlidesTemplate, dict, frozendict.frozendict, None, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + dashboardSlidesTemplate=dashboardSlidesTemplate, + name=name, + widgetSlidesTemplate=widgetSlidesTemplate, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def EXPORT_TEMPLATE(cls): + return cls("exportTemplate") + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportTemplatePatch': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.content_slide_template import ContentSlideTemplate +from gooddata_api_client.model.cover_slide_template import CoverSlideTemplate +from gooddata_api_client.model.intro_slide_template import IntroSlideTemplate +from gooddata_api_client.model.section_slide_template import SectionSlideTemplate diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch_document.pyi new file mode 100644 index 000000000..891f372e4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportTemplatePatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiExportTemplatePatch']: + return JsonApiExportTemplatePatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiExportTemplatePatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportTemplatePatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportTemplatePatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiExportTemplatePatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportTemplatePatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_export_template_patch import JsonApiExportTemplatePatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id.pyi new file mode 100644 index 000000000..1259913e7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id.pyi @@ -0,0 +1,453 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportTemplatePostOptionalId( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of exportTemplate entity. + """ + + + class MetaOapg: + required = { + "attributes", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "name", + } + + class properties: + + + class dashboardSlidesTemplate( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin + ): + + + class MetaOapg: + required = { + "appliedOn", + } + + class properties: + + + class appliedOn( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PDF(cls): + return cls("PDF") + + @schemas.classproperty + def PPTX(cls): + return cls("PPTX") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'appliedOn': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def contentSlide() -> typing.Type['ContentSlideTemplate']: + return ContentSlideTemplate + + @staticmethod + def coverSlide() -> typing.Type['CoverSlideTemplate']: + return CoverSlideTemplate + + @staticmethod + def introSlide() -> typing.Type['IntroSlideTemplate']: + return IntroSlideTemplate + + @staticmethod + def sectionSlide() -> typing.Type['SectionSlideTemplate']: + return SectionSlideTemplate + __annotations__ = { + "appliedOn": appliedOn, + "contentSlide": contentSlide, + "coverSlide": coverSlide, + "introSlide": introSlide, + "sectionSlide": sectionSlide, + } + + + appliedOn: MetaOapg.properties.appliedOn + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["contentSlide"]) -> 'ContentSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["coverSlide"]) -> 'CoverSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["introSlide"]) -> 'IntroSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sectionSlide"]) -> 'SectionSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", "coverSlide", "introSlide", "sectionSlide", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["contentSlide"]) -> typing.Union['ContentSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["coverSlide"]) -> typing.Union['CoverSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["introSlide"]) -> typing.Union['IntroSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sectionSlide"]) -> typing.Union['SectionSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", "coverSlide", "introSlide", "sectionSlide", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + contentSlide: typing.Union['ContentSlideTemplate', schemas.Unset] = schemas.unset, + coverSlide: typing.Union['CoverSlideTemplate', schemas.Unset] = schemas.unset, + introSlide: typing.Union['IntroSlideTemplate', schemas.Unset] = schemas.unset, + sectionSlide: typing.Union['SectionSlideTemplate', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'dashboardSlidesTemplate': + return super().__new__( + cls, + *_args, + contentSlide=contentSlide, + coverSlide=coverSlide, + introSlide=introSlide, + sectionSlide=sectionSlide, + _configuration=_configuration, + **kwargs, + ) + + + class name( + schemas.StrSchema + ): + pass + + + class widgetSlidesTemplate( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin + ): + + + class MetaOapg: + required = { + "appliedOn", + } + + class properties: + + + class appliedOn( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PDF(cls): + return cls("PDF") + + @schemas.classproperty + def PPTX(cls): + return cls("PPTX") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'appliedOn': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def contentSlide() -> typing.Type['ContentSlideTemplate']: + return ContentSlideTemplate + __annotations__ = { + "appliedOn": appliedOn, + "contentSlide": contentSlide, + } + + + appliedOn: MetaOapg.properties.appliedOn + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["contentSlide"]) -> 'ContentSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["contentSlide"]) -> typing.Union['ContentSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + contentSlide: typing.Union['ContentSlideTemplate', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'widgetSlidesTemplate': + return super().__new__( + cls, + *_args, + contentSlide=contentSlide, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "dashboardSlidesTemplate": dashboardSlidesTemplate, + "name": name, + "widgetSlidesTemplate": widgetSlidesTemplate, + } + + name: MetaOapg.properties.name + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardSlidesTemplate"]) -> MetaOapg.properties.dashboardSlidesTemplate: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetSlidesTemplate"]) -> MetaOapg.properties.widgetSlidesTemplate: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dashboardSlidesTemplate", "name", "widgetSlidesTemplate", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardSlidesTemplate"]) -> typing.Union[MetaOapg.properties.dashboardSlidesTemplate, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetSlidesTemplate"]) -> typing.Union[MetaOapg.properties.widgetSlidesTemplate, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dashboardSlidesTemplate", "name", "widgetSlidesTemplate", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + name: typing.Union[MetaOapg.properties.name, str, ], + dashboardSlidesTemplate: typing.Union[MetaOapg.properties.dashboardSlidesTemplate, dict, frozendict.frozendict, None, schemas.Unset] = schemas.unset, + widgetSlidesTemplate: typing.Union[MetaOapg.properties.widgetSlidesTemplate, dict, frozendict.frozendict, None, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + name=name, + dashboardSlidesTemplate=dashboardSlidesTemplate, + widgetSlidesTemplate=widgetSlidesTemplate, + _configuration=_configuration, + **kwargs, + ) + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def EXPORT_TEMPLATE(cls): + return cls("exportTemplate") + + + class id( + schemas.StrSchema + ): + pass + __annotations__ = { + "attributes": attributes, + "type": type, + "id": id, + } + + attributes: MetaOapg.properties.attributes + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "type", "id", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> typing.Union[MetaOapg.properties.id, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "type", "id", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + id: typing.Union[MetaOapg.properties.id, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportTemplatePostOptionalId': + return super().__new__( + cls, + *_args, + attributes=attributes, + type=type, + id=id, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.content_slide_template import ContentSlideTemplate +from gooddata_api_client.model.cover_slide_template import CoverSlideTemplate +from gooddata_api_client.model.intro_slide_template import IntroSlideTemplate +from gooddata_api_client.model.section_slide_template import SectionSlideTemplate diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id_document.pyi new file mode 100644 index 000000000..c8fd94f05 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_post_optional_id_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiExportTemplatePostOptionalIdDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiExportTemplatePostOptionalId']: + return JsonApiExportTemplatePostOptionalId + __annotations__ = { + "data": data, + } + + data: 'JsonApiExportTemplatePostOptionalId' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportTemplatePostOptionalId': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportTemplatePostOptionalId': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiExportTemplatePostOptionalId', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiExportTemplatePostOptionalIdDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_export_template_post_optional_id import JsonApiExportTemplatePostOptionalId diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_fact_patch.pyi new file mode 100644 index 000000000..d92cb2ebc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fact_patch.pyi @@ -0,0 +1,223 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiFactPatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching fact entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def FACT(cls): + return cls("fact") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class description( + schemas.StrSchema + ): + pass + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "description": description, + "tags": tags, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["description", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["description", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + description=description, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiFactPatch': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_fact_patch_document.pyi new file mode 100644 index 000000000..485c6d244 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fact_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiFactPatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiFactPatch']: + return JsonApiFactPatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiFactPatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFactPatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFactPatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiFactPatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiFactPatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_fact_patch import JsonApiFactPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_to_one_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_fact_to_one_linkage.pyi new file mode 100644 index 000000000..781929fcc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fact_to_one_linkage.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiFactToOneLinkage( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + JsonApiFactLinkage, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiFactToOneLinkage': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_fact_linkage import JsonApiFactLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in.pyi new file mode 100644 index 000000000..76da9b929 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in.pyi @@ -0,0 +1,448 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiFilterViewIn( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of filterView entity. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "title", + "content", + } + + class properties: + areRelationsValid = schemas.BoolSchema + content = schemas.DictSchema + + + class description( + schemas.StrSchema + ): + pass + isDefault = schemas.BoolSchema + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "areRelationsValid": areRelationsValid, + "content": content, + "description": description, + "isDefault": isDefault, + "tags": tags, + "title": title, + } + + title: MetaOapg.properties.title + content: MetaOapg.properties.content + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isDefault"]) -> MetaOapg.properties.isDefault: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "isDefault", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isDefault"]) -> typing.Union[MetaOapg.properties.isDefault, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "isDefault", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + title: typing.Union[MetaOapg.properties.title, str, ], + content: typing.Union[MetaOapg.properties.content, dict, frozendict.frozendict, ], + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + isDefault: typing.Union[MetaOapg.properties.isDefault, bool, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + title=title, + content=content, + areRelationsValid=areRelationsValid, + description=description, + isDefault=isDefault, + tags=tags, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def FILTER_VIEW(cls): + return cls("filterView") + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class analyticalDashboard( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAnalyticalDashboardToOneLinkage']: + return JsonApiAnalyticalDashboardToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAnalyticalDashboardToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAnalyticalDashboardToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'analyticalDashboard': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class user( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserToOneLinkage']: + return JsonApiUserToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'user': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "analyticalDashboard": analyticalDashboard, + "user": user, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> MetaOapg.properties.analyticalDashboard: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["user"]) -> MetaOapg.properties.user: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "user", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union[MetaOapg.properties.analyticalDashboard, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["user"]) -> typing.Union[MetaOapg.properties.user, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "user", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + analyticalDashboard: typing.Union[MetaOapg.properties.analyticalDashboard, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + user: typing.Union[MetaOapg.properties.user, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + analyticalDashboard=analyticalDashboard, + user=user, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + "relationships": relationships, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiFilterViewIn': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.model.json_api_user_to_one_linkage import JsonApiUserToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in_document.pyi new file mode 100644 index 000000000..4b3c2ecfc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_in_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiFilterViewInDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiFilterViewIn']: + return JsonApiFilterViewIn + __annotations__ = { + "data": data, + } + + data: 'JsonApiFilterViewIn' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFilterViewIn': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFilterViewIn': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiFilterViewIn', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiFilterViewInDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_filter_view_in import JsonApiFilterViewIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out.pyi new file mode 100644 index 000000000..91c108eb2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out.pyi @@ -0,0 +1,448 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiFilterViewOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of filterView entity. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "title", + "content", + } + + class properties: + areRelationsValid = schemas.BoolSchema + content = schemas.DictSchema + + + class description( + schemas.StrSchema + ): + pass + isDefault = schemas.BoolSchema + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "areRelationsValid": areRelationsValid, + "content": content, + "description": description, + "isDefault": isDefault, + "tags": tags, + "title": title, + } + + title: MetaOapg.properties.title + content: MetaOapg.properties.content + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isDefault"]) -> MetaOapg.properties.isDefault: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "isDefault", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isDefault"]) -> typing.Union[MetaOapg.properties.isDefault, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "isDefault", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + title: typing.Union[MetaOapg.properties.title, str, ], + content: typing.Union[MetaOapg.properties.content, dict, frozendict.frozendict, ], + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + isDefault: typing.Union[MetaOapg.properties.isDefault, bool, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + title=title, + content=content, + areRelationsValid=areRelationsValid, + description=description, + isDefault=isDefault, + tags=tags, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def FILTER_VIEW(cls): + return cls("filterView") + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class analyticalDashboard( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAnalyticalDashboardToOneLinkage']: + return JsonApiAnalyticalDashboardToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAnalyticalDashboardToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAnalyticalDashboardToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'analyticalDashboard': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class user( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserToOneLinkage']: + return JsonApiUserToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'user': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "analyticalDashboard": analyticalDashboard, + "user": user, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> MetaOapg.properties.analyticalDashboard: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["user"]) -> MetaOapg.properties.user: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "user", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union[MetaOapg.properties.analyticalDashboard, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["user"]) -> typing.Union[MetaOapg.properties.user, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "user", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + analyticalDashboard: typing.Union[MetaOapg.properties.analyticalDashboard, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + user: typing.Union[MetaOapg.properties.user, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + analyticalDashboard=analyticalDashboard, + user=user, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + "relationships": relationships, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiFilterViewOut': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.model.json_api_user_to_one_linkage import JsonApiUserToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_document.pyi new file mode 100644 index 000000000..8adb2615f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_document.pyi @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiFilterViewOutDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiFilterViewOut']: + return JsonApiFilterViewOut + + + class included( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiFilterViewOutIncludes']: + return JsonApiFilterViewOutIncludes + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiFilterViewOutIncludes'], typing.List['JsonApiFilterViewOutIncludes']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'included': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiFilterViewOutIncludes': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ObjectLinks']: + return ObjectLinks + __annotations__ = { + "data": data, + "included": included, + "links": links, + } + + data: 'JsonApiFilterViewOut' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFilterViewOut': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFilterViewOut': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiFilterViewOut', + included: typing.Union[MetaOapg.properties.included, list, tuple, schemas.Unset] = schemas.unset, + links: typing.Union['ObjectLinks', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiFilterViewOutDocument': + return super().__new__( + cls, + *_args, + data=data, + included=included, + links=links, + _configuration=_configuration, + **kwargs, + ) + +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 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_includes.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_includes.pyi new file mode 100644 index 000000000..ba6e6b10c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_includes.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiFilterViewOutIncludes( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + JsonApiAnalyticalDashboardOutWithLinks, + JsonApiUserOutWithLinks, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiFilterViewOutIncludes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks +from gooddata_api_client.model.json_api_user_out_with_links import JsonApiUserOutWithLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_list.pyi new file mode 100644 index 000000000..6e666af8e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_list.pyi @@ -0,0 +1,226 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiFilterViewOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiFilterViewOutWithLinks']: + return JsonApiFilterViewOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiFilterViewOutWithLinks'], typing.List['JsonApiFilterViewOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiFilterViewOutWithLinks': + return super().__getitem__(i) + + + class included( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiFilterViewOutIncludes']: + return JsonApiFilterViewOutIncludes + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiFilterViewOutIncludes'], typing.List['JsonApiFilterViewOutIncludes']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'included': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiFilterViewOutIncludes': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "included": included, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + included: typing.Union[MetaOapg.properties.included, list, tuple, schemas.Unset] = schemas.unset, + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiFilterViewOutList': + return super().__new__( + cls, + *_args, + data=data, + included=included, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_filter_view_out_includes import JsonApiFilterViewOutIncludes +from gooddata_api_client.model.json_api_filter_view_out_with_links import JsonApiFilterViewOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_with_links.pyi new file mode 100644 index 000000000..d0df4de6f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiFilterViewOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiFilterViewOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiFilterViewOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_filter_view_out import JsonApiFilterViewOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_patch.pyi new file mode 100644 index 000000000..c6eff33b2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_patch.pyi @@ -0,0 +1,441 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiFilterViewPatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching filterView entity. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + areRelationsValid = schemas.BoolSchema + content = schemas.DictSchema + + + class description( + schemas.StrSchema + ): + pass + isDefault = schemas.BoolSchema + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "areRelationsValid": areRelationsValid, + "content": content, + "description": description, + "isDefault": isDefault, + "tags": tags, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isDefault"]) -> MetaOapg.properties.isDefault: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "isDefault", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union[MetaOapg.properties.content, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isDefault"]) -> typing.Union[MetaOapg.properties.isDefault, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "content", "description", "isDefault", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + content: typing.Union[MetaOapg.properties.content, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + isDefault: typing.Union[MetaOapg.properties.isDefault, bool, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + areRelationsValid=areRelationsValid, + content=content, + description=description, + isDefault=isDefault, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def FILTER_VIEW(cls): + return cls("filterView") + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class analyticalDashboard( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAnalyticalDashboardToOneLinkage']: + return JsonApiAnalyticalDashboardToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAnalyticalDashboardToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAnalyticalDashboardToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'analyticalDashboard': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class user( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserToOneLinkage']: + return JsonApiUserToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'user': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "analyticalDashboard": analyticalDashboard, + "user": user, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> MetaOapg.properties.analyticalDashboard: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["user"]) -> MetaOapg.properties.user: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "user", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union[MetaOapg.properties.analyticalDashboard, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["user"]) -> typing.Union[MetaOapg.properties.user, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "user", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + analyticalDashboard: typing.Union[MetaOapg.properties.analyticalDashboard, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + user: typing.Union[MetaOapg.properties.user, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + analyticalDashboard=analyticalDashboard, + user=user, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + "relationships": relationships, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiFilterViewPatch': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.model.json_api_user_to_one_linkage import JsonApiUserToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_patch_document.pyi new file mode 100644 index 000000000..cef7a7eeb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiFilterViewPatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiFilterViewPatch']: + return JsonApiFilterViewPatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiFilterViewPatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFilterViewPatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiFilterViewPatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiFilterViewPatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiFilterViewPatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_filter_view_patch import JsonApiFilterViewPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_in.pyi new file mode 100644 index 000000000..04cdd3906 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_in.pyi @@ -0,0 +1,428 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiIdentityProviderIn( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of identityProvider entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def IDENTITY_PROVIDER(cls): + return cls("identityProvider") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class customClaimMapping( + schemas.DictSchema + ): + + + class MetaOapg: + additional_properties = schemas.StrSchema + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, str, ], + ) -> 'customClaimMapping': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class identifiers( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'identifiers': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class idpType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MANAGED_IDP(cls): + return cls("MANAGED_IDP") + + @schemas.classproperty + def FIM_IDP(cls): + return cls("FIM_IDP") + + @schemas.classproperty + def DEX_IDP(cls): + return cls("DEX_IDP") + + @schemas.classproperty + def CUSTOM_IDP(cls): + return cls("CUSTOM_IDP") + + + class oauthClientId( + schemas.StrSchema + ): + pass + + + class oauthClientSecret( + schemas.StrSchema + ): + pass + + + class oauthCustomAuthAttributes( + schemas.DictSchema + ): + + + class MetaOapg: + additional_properties = schemas.StrSchema + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, str, ], + ) -> 'oauthCustomAuthAttributes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class oauthCustomScopes( + schemas.ListBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneTupleMixin + ): + + + class MetaOapg: + + + class items( + schemas.StrSchema + ): + pass + + + def __new__( + cls, + *_args: typing.Union[list, tuple, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'oauthCustomScopes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class oauthIssuerId( + schemas.StrSchema + ): + pass + + + class oauthIssuerLocation( + schemas.StrSchema + ): + pass + + + class oauthSubjectIdClaim( + schemas.StrSchema + ): + pass + + + class samlMetadata( + schemas.StrSchema + ): + pass + __annotations__ = { + "customClaimMapping": customClaimMapping, + "identifiers": identifiers, + "idpType": idpType, + "oauthClientId": oauthClientId, + "oauthClientSecret": oauthClientSecret, + "oauthCustomAuthAttributes": oauthCustomAuthAttributes, + "oauthCustomScopes": oauthCustomScopes, + "oauthIssuerId": oauthIssuerId, + "oauthIssuerLocation": oauthIssuerLocation, + "oauthSubjectIdClaim": oauthSubjectIdClaim, + "samlMetadata": samlMetadata, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["customClaimMapping"]) -> MetaOapg.properties.customClaimMapping: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["identifiers"]) -> MetaOapg.properties.identifiers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["idpType"]) -> MetaOapg.properties.idpType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthClientId"]) -> MetaOapg.properties.oauthClientId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthClientSecret"]) -> MetaOapg.properties.oauthClientSecret: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthCustomAuthAttributes"]) -> MetaOapg.properties.oauthCustomAuthAttributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthCustomScopes"]) -> MetaOapg.properties.oauthCustomScopes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthIssuerId"]) -> MetaOapg.properties.oauthIssuerId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthIssuerLocation"]) -> MetaOapg.properties.oauthIssuerLocation: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthSubjectIdClaim"]) -> MetaOapg.properties.oauthSubjectIdClaim: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["samlMetadata"]) -> MetaOapg.properties.samlMetadata: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["customClaimMapping", "identifiers", "idpType", "oauthClientId", "oauthClientSecret", "oauthCustomAuthAttributes", "oauthCustomScopes", "oauthIssuerId", "oauthIssuerLocation", "oauthSubjectIdClaim", "samlMetadata", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["customClaimMapping"]) -> typing.Union[MetaOapg.properties.customClaimMapping, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["identifiers"]) -> typing.Union[MetaOapg.properties.identifiers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["idpType"]) -> typing.Union[MetaOapg.properties.idpType, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthClientId"]) -> typing.Union[MetaOapg.properties.oauthClientId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthClientSecret"]) -> typing.Union[MetaOapg.properties.oauthClientSecret, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthCustomAuthAttributes"]) -> typing.Union[MetaOapg.properties.oauthCustomAuthAttributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthCustomScopes"]) -> typing.Union[MetaOapg.properties.oauthCustomScopes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthIssuerId"]) -> typing.Union[MetaOapg.properties.oauthIssuerId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthIssuerLocation"]) -> typing.Union[MetaOapg.properties.oauthIssuerLocation, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthSubjectIdClaim"]) -> typing.Union[MetaOapg.properties.oauthSubjectIdClaim, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["samlMetadata"]) -> typing.Union[MetaOapg.properties.samlMetadata, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["customClaimMapping", "identifiers", "idpType", "oauthClientId", "oauthClientSecret", "oauthCustomAuthAttributes", "oauthCustomScopes", "oauthIssuerId", "oauthIssuerLocation", "oauthSubjectIdClaim", "samlMetadata", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + customClaimMapping: typing.Union[MetaOapg.properties.customClaimMapping, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + identifiers: typing.Union[MetaOapg.properties.identifiers, list, tuple, schemas.Unset] = schemas.unset, + idpType: typing.Union[MetaOapg.properties.idpType, str, schemas.Unset] = schemas.unset, + oauthClientId: typing.Union[MetaOapg.properties.oauthClientId, str, schemas.Unset] = schemas.unset, + oauthClientSecret: typing.Union[MetaOapg.properties.oauthClientSecret, str, schemas.Unset] = schemas.unset, + oauthCustomAuthAttributes: typing.Union[MetaOapg.properties.oauthCustomAuthAttributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + oauthCustomScopes: typing.Union[MetaOapg.properties.oauthCustomScopes, list, tuple, None, schemas.Unset] = schemas.unset, + oauthIssuerId: typing.Union[MetaOapg.properties.oauthIssuerId, str, schemas.Unset] = schemas.unset, + oauthIssuerLocation: typing.Union[MetaOapg.properties.oauthIssuerLocation, str, schemas.Unset] = schemas.unset, + oauthSubjectIdClaim: typing.Union[MetaOapg.properties.oauthSubjectIdClaim, str, schemas.Unset] = schemas.unset, + samlMetadata: typing.Union[MetaOapg.properties.samlMetadata, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + customClaimMapping=customClaimMapping, + identifiers=identifiers, + idpType=idpType, + oauthClientId=oauthClientId, + oauthClientSecret=oauthClientSecret, + oauthCustomAuthAttributes=oauthCustomAuthAttributes, + oauthCustomScopes=oauthCustomScopes, + oauthIssuerId=oauthIssuerId, + oauthIssuerLocation=oauthIssuerLocation, + oauthSubjectIdClaim=oauthSubjectIdClaim, + samlMetadata=samlMetadata, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiIdentityProviderIn': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_in_document.pyi new file mode 100644 index 000000000..f417c930e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_in_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiIdentityProviderInDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiIdentityProviderIn']: + return JsonApiIdentityProviderIn + __annotations__ = { + "data": data, + } + + data: 'JsonApiIdentityProviderIn' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiIdentityProviderIn': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiIdentityProviderIn': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiIdentityProviderIn', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiIdentityProviderInDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_identity_provider_in import JsonApiIdentityProviderIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_linkage.pyi new file mode 100644 index 000000000..a9d9bb604 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_linkage.pyi @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiIdentityProviderLinkage( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + The \"type\" and \"id\" to non-empty members. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def IDENTITY_PROVIDER(cls): + return cls("identityProvider") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiIdentityProviderLinkage': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out.pyi new file mode 100644 index 000000000..80acedf74 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out.pyi @@ -0,0 +1,398 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiIdentityProviderOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of identityProvider entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def IDENTITY_PROVIDER(cls): + return cls("identityProvider") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class customClaimMapping( + schemas.DictSchema + ): + + + class MetaOapg: + additional_properties = schemas.StrSchema + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, str, ], + ) -> 'customClaimMapping': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class identifiers( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'identifiers': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class idpType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MANAGED_IDP(cls): + return cls("MANAGED_IDP") + + @schemas.classproperty + def FIM_IDP(cls): + return cls("FIM_IDP") + + @schemas.classproperty + def DEX_IDP(cls): + return cls("DEX_IDP") + + @schemas.classproperty + def CUSTOM_IDP(cls): + return cls("CUSTOM_IDP") + + + class oauthClientId( + schemas.StrSchema + ): + pass + + + class oauthCustomAuthAttributes( + schemas.DictSchema + ): + + + class MetaOapg: + additional_properties = schemas.StrSchema + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, str, ], + ) -> 'oauthCustomAuthAttributes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class oauthCustomScopes( + schemas.ListBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneTupleMixin + ): + + + class MetaOapg: + + + class items( + schemas.StrSchema + ): + pass + + + def __new__( + cls, + *_args: typing.Union[list, tuple, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'oauthCustomScopes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class oauthIssuerId( + schemas.StrSchema + ): + pass + + + class oauthIssuerLocation( + schemas.StrSchema + ): + pass + + + class oauthSubjectIdClaim( + schemas.StrSchema + ): + pass + __annotations__ = { + "customClaimMapping": customClaimMapping, + "identifiers": identifiers, + "idpType": idpType, + "oauthClientId": oauthClientId, + "oauthCustomAuthAttributes": oauthCustomAuthAttributes, + "oauthCustomScopes": oauthCustomScopes, + "oauthIssuerId": oauthIssuerId, + "oauthIssuerLocation": oauthIssuerLocation, + "oauthSubjectIdClaim": oauthSubjectIdClaim, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["customClaimMapping"]) -> MetaOapg.properties.customClaimMapping: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["identifiers"]) -> MetaOapg.properties.identifiers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["idpType"]) -> MetaOapg.properties.idpType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthClientId"]) -> MetaOapg.properties.oauthClientId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthCustomAuthAttributes"]) -> MetaOapg.properties.oauthCustomAuthAttributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthCustomScopes"]) -> MetaOapg.properties.oauthCustomScopes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthIssuerId"]) -> MetaOapg.properties.oauthIssuerId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthIssuerLocation"]) -> MetaOapg.properties.oauthIssuerLocation: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthSubjectIdClaim"]) -> MetaOapg.properties.oauthSubjectIdClaim: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["customClaimMapping", "identifiers", "idpType", "oauthClientId", "oauthCustomAuthAttributes", "oauthCustomScopes", "oauthIssuerId", "oauthIssuerLocation", "oauthSubjectIdClaim", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["customClaimMapping"]) -> typing.Union[MetaOapg.properties.customClaimMapping, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["identifiers"]) -> typing.Union[MetaOapg.properties.identifiers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["idpType"]) -> typing.Union[MetaOapg.properties.idpType, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthClientId"]) -> typing.Union[MetaOapg.properties.oauthClientId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthCustomAuthAttributes"]) -> typing.Union[MetaOapg.properties.oauthCustomAuthAttributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthCustomScopes"]) -> typing.Union[MetaOapg.properties.oauthCustomScopes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthIssuerId"]) -> typing.Union[MetaOapg.properties.oauthIssuerId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthIssuerLocation"]) -> typing.Union[MetaOapg.properties.oauthIssuerLocation, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthSubjectIdClaim"]) -> typing.Union[MetaOapg.properties.oauthSubjectIdClaim, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["customClaimMapping", "identifiers", "idpType", "oauthClientId", "oauthCustomAuthAttributes", "oauthCustomScopes", "oauthIssuerId", "oauthIssuerLocation", "oauthSubjectIdClaim", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + customClaimMapping: typing.Union[MetaOapg.properties.customClaimMapping, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + identifiers: typing.Union[MetaOapg.properties.identifiers, list, tuple, schemas.Unset] = schemas.unset, + idpType: typing.Union[MetaOapg.properties.idpType, str, schemas.Unset] = schemas.unset, + oauthClientId: typing.Union[MetaOapg.properties.oauthClientId, str, schemas.Unset] = schemas.unset, + oauthCustomAuthAttributes: typing.Union[MetaOapg.properties.oauthCustomAuthAttributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + oauthCustomScopes: typing.Union[MetaOapg.properties.oauthCustomScopes, list, tuple, None, schemas.Unset] = schemas.unset, + oauthIssuerId: typing.Union[MetaOapg.properties.oauthIssuerId, str, schemas.Unset] = schemas.unset, + oauthIssuerLocation: typing.Union[MetaOapg.properties.oauthIssuerLocation, str, schemas.Unset] = schemas.unset, + oauthSubjectIdClaim: typing.Union[MetaOapg.properties.oauthSubjectIdClaim, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + customClaimMapping=customClaimMapping, + identifiers=identifiers, + idpType=idpType, + oauthClientId=oauthClientId, + oauthCustomAuthAttributes=oauthCustomAuthAttributes, + oauthCustomScopes=oauthCustomScopes, + oauthIssuerId=oauthIssuerId, + oauthIssuerLocation=oauthIssuerLocation, + oauthSubjectIdClaim=oauthSubjectIdClaim, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiIdentityProviderOut': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_document.pyi new file mode 100644 index 000000000..0357c96c7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_document.pyi @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiIdentityProviderOutDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiIdentityProviderOut']: + return JsonApiIdentityProviderOut + + @staticmethod + def links() -> typing.Type['ObjectLinks']: + return ObjectLinks + __annotations__ = { + "data": data, + "links": links, + } + + data: 'JsonApiIdentityProviderOut' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiIdentityProviderOut': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiIdentityProviderOut': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiIdentityProviderOut', + links: typing.Union['ObjectLinks', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiIdentityProviderOutDocument': + return super().__new__( + cls, + *_args, + data=data, + links=links, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_identity_provider_out import JsonApiIdentityProviderOut +from gooddata_api_client.model.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_list.pyi new file mode 100644 index 000000000..7007494ce --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_list.pyi @@ -0,0 +1,190 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiIdentityProviderOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiIdentityProviderOutWithLinks']: + return JsonApiIdentityProviderOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiIdentityProviderOutWithLinks'], typing.List['JsonApiIdentityProviderOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiIdentityProviderOutWithLinks': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiIdentityProviderOutList': + return super().__new__( + cls, + *_args, + data=data, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_identity_provider_out_with_links import JsonApiIdentityProviderOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_with_links.pyi new file mode 100644 index 000000000..ac17c728e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiIdentityProviderOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiIdentityProviderOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiIdentityProviderOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_identity_provider_out import JsonApiIdentityProviderOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_patch.pyi new file mode 100644 index 000000000..77f2b4766 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_patch.pyi @@ -0,0 +1,428 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiIdentityProviderPatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching identityProvider entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def IDENTITY_PROVIDER(cls): + return cls("identityProvider") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class customClaimMapping( + schemas.DictSchema + ): + + + class MetaOapg: + additional_properties = schemas.StrSchema + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, str, ], + ) -> 'customClaimMapping': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class identifiers( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'identifiers': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class idpType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MANAGED_IDP(cls): + return cls("MANAGED_IDP") + + @schemas.classproperty + def FIM_IDP(cls): + return cls("FIM_IDP") + + @schemas.classproperty + def DEX_IDP(cls): + return cls("DEX_IDP") + + @schemas.classproperty + def CUSTOM_IDP(cls): + return cls("CUSTOM_IDP") + + + class oauthClientId( + schemas.StrSchema + ): + pass + + + class oauthClientSecret( + schemas.StrSchema + ): + pass + + + class oauthCustomAuthAttributes( + schemas.DictSchema + ): + + + class MetaOapg: + additional_properties = schemas.StrSchema + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, str, ], + ) -> 'oauthCustomAuthAttributes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class oauthCustomScopes( + schemas.ListBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneTupleMixin + ): + + + class MetaOapg: + + + class items( + schemas.StrSchema + ): + pass + + + def __new__( + cls, + *_args: typing.Union[list, tuple, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'oauthCustomScopes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class oauthIssuerId( + schemas.StrSchema + ): + pass + + + class oauthIssuerLocation( + schemas.StrSchema + ): + pass + + + class oauthSubjectIdClaim( + schemas.StrSchema + ): + pass + + + class samlMetadata( + schemas.StrSchema + ): + pass + __annotations__ = { + "customClaimMapping": customClaimMapping, + "identifiers": identifiers, + "idpType": idpType, + "oauthClientId": oauthClientId, + "oauthClientSecret": oauthClientSecret, + "oauthCustomAuthAttributes": oauthCustomAuthAttributes, + "oauthCustomScopes": oauthCustomScopes, + "oauthIssuerId": oauthIssuerId, + "oauthIssuerLocation": oauthIssuerLocation, + "oauthSubjectIdClaim": oauthSubjectIdClaim, + "samlMetadata": samlMetadata, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["customClaimMapping"]) -> MetaOapg.properties.customClaimMapping: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["identifiers"]) -> MetaOapg.properties.identifiers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["idpType"]) -> MetaOapg.properties.idpType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthClientId"]) -> MetaOapg.properties.oauthClientId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthClientSecret"]) -> MetaOapg.properties.oauthClientSecret: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthCustomAuthAttributes"]) -> MetaOapg.properties.oauthCustomAuthAttributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthCustomScopes"]) -> MetaOapg.properties.oauthCustomScopes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthIssuerId"]) -> MetaOapg.properties.oauthIssuerId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthIssuerLocation"]) -> MetaOapg.properties.oauthIssuerLocation: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["oauthSubjectIdClaim"]) -> MetaOapg.properties.oauthSubjectIdClaim: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["samlMetadata"]) -> MetaOapg.properties.samlMetadata: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["customClaimMapping", "identifiers", "idpType", "oauthClientId", "oauthClientSecret", "oauthCustomAuthAttributes", "oauthCustomScopes", "oauthIssuerId", "oauthIssuerLocation", "oauthSubjectIdClaim", "samlMetadata", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["customClaimMapping"]) -> typing.Union[MetaOapg.properties.customClaimMapping, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["identifiers"]) -> typing.Union[MetaOapg.properties.identifiers, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["idpType"]) -> typing.Union[MetaOapg.properties.idpType, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthClientId"]) -> typing.Union[MetaOapg.properties.oauthClientId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthClientSecret"]) -> typing.Union[MetaOapg.properties.oauthClientSecret, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthCustomAuthAttributes"]) -> typing.Union[MetaOapg.properties.oauthCustomAuthAttributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthCustomScopes"]) -> typing.Union[MetaOapg.properties.oauthCustomScopes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthIssuerId"]) -> typing.Union[MetaOapg.properties.oauthIssuerId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthIssuerLocation"]) -> typing.Union[MetaOapg.properties.oauthIssuerLocation, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["oauthSubjectIdClaim"]) -> typing.Union[MetaOapg.properties.oauthSubjectIdClaim, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["samlMetadata"]) -> typing.Union[MetaOapg.properties.samlMetadata, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["customClaimMapping", "identifiers", "idpType", "oauthClientId", "oauthClientSecret", "oauthCustomAuthAttributes", "oauthCustomScopes", "oauthIssuerId", "oauthIssuerLocation", "oauthSubjectIdClaim", "samlMetadata", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + customClaimMapping: typing.Union[MetaOapg.properties.customClaimMapping, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + identifiers: typing.Union[MetaOapg.properties.identifiers, list, tuple, schemas.Unset] = schemas.unset, + idpType: typing.Union[MetaOapg.properties.idpType, str, schemas.Unset] = schemas.unset, + oauthClientId: typing.Union[MetaOapg.properties.oauthClientId, str, schemas.Unset] = schemas.unset, + oauthClientSecret: typing.Union[MetaOapg.properties.oauthClientSecret, str, schemas.Unset] = schemas.unset, + oauthCustomAuthAttributes: typing.Union[MetaOapg.properties.oauthCustomAuthAttributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + oauthCustomScopes: typing.Union[MetaOapg.properties.oauthCustomScopes, list, tuple, None, schemas.Unset] = schemas.unset, + oauthIssuerId: typing.Union[MetaOapg.properties.oauthIssuerId, str, schemas.Unset] = schemas.unset, + oauthIssuerLocation: typing.Union[MetaOapg.properties.oauthIssuerLocation, str, schemas.Unset] = schemas.unset, + oauthSubjectIdClaim: typing.Union[MetaOapg.properties.oauthSubjectIdClaim, str, schemas.Unset] = schemas.unset, + samlMetadata: typing.Union[MetaOapg.properties.samlMetadata, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + customClaimMapping=customClaimMapping, + identifiers=identifiers, + idpType=idpType, + oauthClientId=oauthClientId, + oauthClientSecret=oauthClientSecret, + oauthCustomAuthAttributes=oauthCustomAuthAttributes, + oauthCustomScopes=oauthCustomScopes, + oauthIssuerId=oauthIssuerId, + oauthIssuerLocation=oauthIssuerLocation, + oauthSubjectIdClaim=oauthSubjectIdClaim, + samlMetadata=samlMetadata, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiIdentityProviderPatch': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_patch_document.pyi new file mode 100644 index 000000000..624cc2565 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiIdentityProviderPatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiIdentityProviderPatch']: + return JsonApiIdentityProviderPatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiIdentityProviderPatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiIdentityProviderPatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiIdentityProviderPatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiIdentityProviderPatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiIdentityProviderPatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_identity_provider_patch import JsonApiIdentityProviderPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_to_one_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_to_one_linkage.pyi new file mode 100644 index 000000000..6d1d1ad0c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_to_one_linkage.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiIdentityProviderToOneLinkage( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + JsonApiIdentityProviderLinkage, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiIdentityProviderToOneLinkage': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_identity_provider_linkage import JsonApiIdentityProviderLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in.pyi new file mode 100644 index 000000000..faaa6be71 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in.pyi @@ -0,0 +1,209 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiJwkIn( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of jwk entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def JWK(cls): + return cls("jwk") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class content( + schemas.ComposedBase, + schemas.DictSchema + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + RsaSpecification, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'content': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "content": content, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["content", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union[MetaOapg.properties.content, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["content", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + content: typing.Union[MetaOapg.properties.content, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + content=content, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiJwkIn': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.rsa_specification import RsaSpecification diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes_content.py b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes_content.py index 3554ced2b..2bef1e6a6 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes_content.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes_content.py @@ -74,6 +74,12 @@ class JsonApiJwkInAttributesContent(ModelComposed): } validations = { + ('kid',): { + 'max_length': 255, + 'regex': { + 'pattern': r'^[^.]', # noqa: E501 + }, + }, } @cached_property diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_document.pyi new file mode 100644 index 000000000..388d3bddd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiJwkInDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiJwkIn']: + return JsonApiJwkIn + __annotations__ = { + "data": data, + } + + data: 'JsonApiJwkIn' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiJwkIn': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiJwkIn': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiJwkIn', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiJwkInDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_jwk_in import JsonApiJwkIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out.pyi new file mode 100644 index 000000000..b48beb3e4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out.pyi @@ -0,0 +1,209 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiJwkOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of jwk entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def JWK(cls): + return cls("jwk") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class content( + schemas.ComposedBase, + schemas.DictSchema + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + RsaSpecification, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'content': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "content": content, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["content", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union[MetaOapg.properties.content, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["content", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + content: typing.Union[MetaOapg.properties.content, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + content=content, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiJwkOut': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.rsa_specification import RsaSpecification diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_document.pyi new file mode 100644 index 000000000..6d13fdfaf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_document.pyi @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiJwkOutDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiJwkOut']: + return JsonApiJwkOut + + @staticmethod + def links() -> typing.Type['ObjectLinks']: + return ObjectLinks + __annotations__ = { + "data": data, + "links": links, + } + + data: 'JsonApiJwkOut' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiJwkOut': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiJwkOut': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiJwkOut', + links: typing.Union['ObjectLinks', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiJwkOutDocument': + return super().__new__( + cls, + *_args, + data=data, + links=links, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_jwk_out import JsonApiJwkOut +from gooddata_api_client.model.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_list.pyi new file mode 100644 index 000000000..cede11d25 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_list.pyi @@ -0,0 +1,190 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiJwkOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiJwkOutWithLinks']: + return JsonApiJwkOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiJwkOutWithLinks'], typing.List['JsonApiJwkOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiJwkOutWithLinks': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiJwkOutList': + return super().__new__( + cls, + *_args, + data=data, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_jwk_out_with_links import JsonApiJwkOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_with_links.pyi new file mode 100644 index 000000000..a94d90c6a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiJwkOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiJwkOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiJwkOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_jwk_out import JsonApiJwkOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_patch.pyi new file mode 100644 index 000000000..7b05671f4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_patch.pyi @@ -0,0 +1,209 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiJwkPatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching jwk entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def JWK(cls): + return cls("jwk") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class content( + schemas.ComposedBase, + schemas.DictSchema + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + RsaSpecification, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'content': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "content": content, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["content", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union[MetaOapg.properties.content, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["content", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + content: typing.Union[MetaOapg.properties.content, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + content=content, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiJwkPatch': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.rsa_specification import RsaSpecification diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_patch_document.pyi new file mode 100644 index 000000000..0865b36fc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiJwkPatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiJwkPatch']: + return JsonApiJwkPatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiJwkPatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiJwkPatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiJwkPatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiJwkPatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiJwkPatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_jwk_patch import JsonApiJwkPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_in.pyi new file mode 100644 index 000000000..dc8e63402 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_in.pyi @@ -0,0 +1,627 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiKnowledgeRecommendationIn( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of knowledgeRecommendation entity. + """ + + + class MetaOapg: + required = { + "relationships", + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "comparisonType", + "title", + "direction", + } + + class properties: + + + class analyticalDashboardTitle( + schemas.StrSchema + ): + pass + + + class analyzedPeriod( + schemas.StrSchema + ): + pass + analyzedValue = schemas.AnyTypeSchema + areRelationsValid = schemas.BoolSchema + + + class comparisonType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MONTH(cls): + return cls("MONTH") + + @schemas.classproperty + def QUARTER(cls): + return cls("QUARTER") + + @schemas.classproperty + def YEAR(cls): + return cls("YEAR") + confidence = schemas.AnyTypeSchema + + + class description( + schemas.StrSchema + ): + pass + + + class direction( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INCREASED(cls): + return cls("INCREASED") + + @schemas.classproperty + def DECREASED(cls): + return cls("DECREASED") + + + class metricTitle( + schemas.StrSchema + ): + pass + recommendations = schemas.DictSchema + + + class referencePeriod( + schemas.StrSchema + ): + pass + referenceValue = schemas.AnyTypeSchema + sourceCount = schemas.Int32Schema + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + + + class widgetId( + schemas.StrSchema + ): + pass + + + class widgetName( + schemas.StrSchema + ): + pass + __annotations__ = { + "analyticalDashboardTitle": analyticalDashboardTitle, + "analyzedPeriod": analyzedPeriod, + "analyzedValue": analyzedValue, + "areRelationsValid": areRelationsValid, + "comparisonType": comparisonType, + "confidence": confidence, + "description": description, + "direction": direction, + "metricTitle": metricTitle, + "recommendations": recommendations, + "referencePeriod": referencePeriod, + "referenceValue": referenceValue, + "sourceCount": sourceCount, + "tags": tags, + "title": title, + "widgetId": widgetId, + "widgetName": widgetName, + } + + comparisonType: MetaOapg.properties.comparisonType + title: MetaOapg.properties.title + direction: MetaOapg.properties.direction + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboardTitle"]) -> MetaOapg.properties.analyticalDashboardTitle: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyzedPeriod"]) -> MetaOapg.properties.analyzedPeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyzedValue"]) -> MetaOapg.properties.analyzedValue: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["comparisonType"]) -> MetaOapg.properties.comparisonType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["confidence"]) -> MetaOapg.properties.confidence: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["direction"]) -> MetaOapg.properties.direction: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metricTitle"]) -> MetaOapg.properties.metricTitle: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["recommendations"]) -> MetaOapg.properties.recommendations: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["referencePeriod"]) -> MetaOapg.properties.referencePeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["referenceValue"]) -> MetaOapg.properties.referenceValue: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sourceCount"]) -> MetaOapg.properties.sourceCount: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetId"]) -> MetaOapg.properties.widgetId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetName"]) -> MetaOapg.properties.widgetName: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboardTitle", "analyzedPeriod", "analyzedValue", "areRelationsValid", "comparisonType", "confidence", "description", "direction", "metricTitle", "recommendations", "referencePeriod", "referenceValue", "sourceCount", "tags", "title", "widgetId", "widgetName", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboardTitle"]) -> typing.Union[MetaOapg.properties.analyticalDashboardTitle, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyzedPeriod"]) -> typing.Union[MetaOapg.properties.analyzedPeriod, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyzedValue"]) -> typing.Union[MetaOapg.properties.analyzedValue, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["comparisonType"]) -> MetaOapg.properties.comparisonType: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["confidence"]) -> typing.Union[MetaOapg.properties.confidence, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["direction"]) -> MetaOapg.properties.direction: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metricTitle"]) -> typing.Union[MetaOapg.properties.metricTitle, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["recommendations"]) -> typing.Union[MetaOapg.properties.recommendations, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["referencePeriod"]) -> typing.Union[MetaOapg.properties.referencePeriod, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["referenceValue"]) -> typing.Union[MetaOapg.properties.referenceValue, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sourceCount"]) -> typing.Union[MetaOapg.properties.sourceCount, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetId"]) -> typing.Union[MetaOapg.properties.widgetId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetName"]) -> typing.Union[MetaOapg.properties.widgetName, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboardTitle", "analyzedPeriod", "analyzedValue", "areRelationsValid", "comparisonType", "confidence", "description", "direction", "metricTitle", "recommendations", "referencePeriod", "referenceValue", "sourceCount", "tags", "title", "widgetId", "widgetName", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + comparisonType: typing.Union[MetaOapg.properties.comparisonType, str, ], + title: typing.Union[MetaOapg.properties.title, str, ], + direction: typing.Union[MetaOapg.properties.direction, str, ], + analyticalDashboardTitle: typing.Union[MetaOapg.properties.analyticalDashboardTitle, str, schemas.Unset] = schemas.unset, + analyzedPeriod: typing.Union[MetaOapg.properties.analyzedPeriod, str, schemas.Unset] = schemas.unset, + analyzedValue: typing.Union[MetaOapg.properties.analyzedValue, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + confidence: typing.Union[MetaOapg.properties.confidence, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + metricTitle: typing.Union[MetaOapg.properties.metricTitle, str, schemas.Unset] = schemas.unset, + recommendations: typing.Union[MetaOapg.properties.recommendations, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + referencePeriod: typing.Union[MetaOapg.properties.referencePeriod, str, schemas.Unset] = schemas.unset, + referenceValue: typing.Union[MetaOapg.properties.referenceValue, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + sourceCount: typing.Union[MetaOapg.properties.sourceCount, decimal.Decimal, int, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + widgetId: typing.Union[MetaOapg.properties.widgetId, str, schemas.Unset] = schemas.unset, + widgetName: typing.Union[MetaOapg.properties.widgetName, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + comparisonType=comparisonType, + title=title, + direction=direction, + analyticalDashboardTitle=analyticalDashboardTitle, + analyzedPeriod=analyzedPeriod, + analyzedValue=analyzedValue, + areRelationsValid=areRelationsValid, + confidence=confidence, + description=description, + metricTitle=metricTitle, + recommendations=recommendations, + referencePeriod=referencePeriod, + referenceValue=referenceValue, + sourceCount=sourceCount, + tags=tags, + widgetId=widgetId, + widgetName=widgetName, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "metric", + } + + class properties: + + + class analyticalDashboard( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAnalyticalDashboardToOneLinkage']: + return JsonApiAnalyticalDashboardToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAnalyticalDashboardToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAnalyticalDashboardToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'analyticalDashboard': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class metric( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiMetricToOneLinkage']: + return JsonApiMetricToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiMetricToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiMetricToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'metric': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "analyticalDashboard": analyticalDashboard, + "metric": metric, + } + + metric: MetaOapg.properties.metric + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> MetaOapg.properties.analyticalDashboard: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metric"]) -> MetaOapg.properties.metric: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "metric", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union[MetaOapg.properties.analyticalDashboard, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metric"]) -> MetaOapg.properties.metric: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "metric", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + metric: typing.Union[MetaOapg.properties.metric, dict, frozendict.frozendict, ], + analyticalDashboard: typing.Union[MetaOapg.properties.analyticalDashboard, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + metric=metric, + analyticalDashboard=analyticalDashboard, + _configuration=_configuration, + **kwargs, + ) + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def KNOWLEDGE_RECOMMENDATION(cls): + return cls("knowledgeRecommendation") + __annotations__ = { + "attributes": attributes, + "id": id, + "relationships": relationships, + "type": type, + } + + relationships: MetaOapg.properties.relationships + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "relationships", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "relationships", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiKnowledgeRecommendationIn': + return super().__new__( + cls, + *_args, + relationships=relationships, + attributes=attributes, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.model.json_api_metric_to_one_linkage import JsonApiMetricToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_in_document.pyi new file mode 100644 index 000000000..195579d35 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_in_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiKnowledgeRecommendationInDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiKnowledgeRecommendationIn']: + return JsonApiKnowledgeRecommendationIn + __annotations__ = { + "data": data, + } + + data: 'JsonApiKnowledgeRecommendationIn' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiKnowledgeRecommendationIn': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiKnowledgeRecommendationIn': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiKnowledgeRecommendationIn', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiKnowledgeRecommendationInDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_knowledge_recommendation_in import JsonApiKnowledgeRecommendationIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out.pyi new file mode 100644 index 000000000..e39f18664 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out.pyi @@ -0,0 +1,768 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiKnowledgeRecommendationOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of knowledgeRecommendation entity. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "comparisonType", + "title", + "direction", + } + + class properties: + + + class analyticalDashboardTitle( + schemas.StrSchema + ): + pass + + + class analyzedPeriod( + schemas.StrSchema + ): + pass + analyzedValue = schemas.AnyTypeSchema + areRelationsValid = schemas.BoolSchema + + + class comparisonType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MONTH(cls): + return cls("MONTH") + + @schemas.classproperty + def QUARTER(cls): + return cls("QUARTER") + + @schemas.classproperty + def YEAR(cls): + return cls("YEAR") + confidence = schemas.AnyTypeSchema + createdAt = schemas.DateTimeSchema + + + class description( + schemas.StrSchema + ): + pass + + + class direction( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INCREASED(cls): + return cls("INCREASED") + + @schemas.classproperty + def DECREASED(cls): + return cls("DECREASED") + + + class metricTitle( + schemas.StrSchema + ): + pass + recommendations = schemas.DictSchema + + + class referencePeriod( + schemas.StrSchema + ): + pass + referenceValue = schemas.AnyTypeSchema + sourceCount = schemas.Int32Schema + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + + + class widgetId( + schemas.StrSchema + ): + pass + + + class widgetName( + schemas.StrSchema + ): + pass + __annotations__ = { + "analyticalDashboardTitle": analyticalDashboardTitle, + "analyzedPeriod": analyzedPeriod, + "analyzedValue": analyzedValue, + "areRelationsValid": areRelationsValid, + "comparisonType": comparisonType, + "confidence": confidence, + "createdAt": createdAt, + "description": description, + "direction": direction, + "metricTitle": metricTitle, + "recommendations": recommendations, + "referencePeriod": referencePeriod, + "referenceValue": referenceValue, + "sourceCount": sourceCount, + "tags": tags, + "title": title, + "widgetId": widgetId, + "widgetName": widgetName, + } + + comparisonType: MetaOapg.properties.comparisonType + title: MetaOapg.properties.title + direction: MetaOapg.properties.direction + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboardTitle"]) -> MetaOapg.properties.analyticalDashboardTitle: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyzedPeriod"]) -> MetaOapg.properties.analyzedPeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyzedValue"]) -> MetaOapg.properties.analyzedValue: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["comparisonType"]) -> MetaOapg.properties.comparisonType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["confidence"]) -> MetaOapg.properties.confidence: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdAt"]) -> MetaOapg.properties.createdAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["direction"]) -> MetaOapg.properties.direction: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metricTitle"]) -> MetaOapg.properties.metricTitle: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["recommendations"]) -> MetaOapg.properties.recommendations: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["referencePeriod"]) -> MetaOapg.properties.referencePeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["referenceValue"]) -> MetaOapg.properties.referenceValue: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sourceCount"]) -> MetaOapg.properties.sourceCount: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetId"]) -> MetaOapg.properties.widgetId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetName"]) -> MetaOapg.properties.widgetName: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboardTitle", "analyzedPeriod", "analyzedValue", "areRelationsValid", "comparisonType", "confidence", "createdAt", "description", "direction", "metricTitle", "recommendations", "referencePeriod", "referenceValue", "sourceCount", "tags", "title", "widgetId", "widgetName", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboardTitle"]) -> typing.Union[MetaOapg.properties.analyticalDashboardTitle, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyzedPeriod"]) -> typing.Union[MetaOapg.properties.analyzedPeriod, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyzedValue"]) -> typing.Union[MetaOapg.properties.analyzedValue, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["comparisonType"]) -> MetaOapg.properties.comparisonType: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["confidence"]) -> typing.Union[MetaOapg.properties.confidence, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdAt"]) -> typing.Union[MetaOapg.properties.createdAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["direction"]) -> MetaOapg.properties.direction: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metricTitle"]) -> typing.Union[MetaOapg.properties.metricTitle, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["recommendations"]) -> typing.Union[MetaOapg.properties.recommendations, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["referencePeriod"]) -> typing.Union[MetaOapg.properties.referencePeriod, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["referenceValue"]) -> typing.Union[MetaOapg.properties.referenceValue, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sourceCount"]) -> typing.Union[MetaOapg.properties.sourceCount, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetId"]) -> typing.Union[MetaOapg.properties.widgetId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetName"]) -> typing.Union[MetaOapg.properties.widgetName, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboardTitle", "analyzedPeriod", "analyzedValue", "areRelationsValid", "comparisonType", "confidence", "createdAt", "description", "direction", "metricTitle", "recommendations", "referencePeriod", "referenceValue", "sourceCount", "tags", "title", "widgetId", "widgetName", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + comparisonType: typing.Union[MetaOapg.properties.comparisonType, str, ], + title: typing.Union[MetaOapg.properties.title, str, ], + direction: typing.Union[MetaOapg.properties.direction, str, ], + analyticalDashboardTitle: typing.Union[MetaOapg.properties.analyticalDashboardTitle, str, schemas.Unset] = schemas.unset, + analyzedPeriod: typing.Union[MetaOapg.properties.analyzedPeriod, str, schemas.Unset] = schemas.unset, + analyzedValue: typing.Union[MetaOapg.properties.analyzedValue, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + confidence: typing.Union[MetaOapg.properties.confidence, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + createdAt: typing.Union[MetaOapg.properties.createdAt, str, datetime, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + metricTitle: typing.Union[MetaOapg.properties.metricTitle, str, schemas.Unset] = schemas.unset, + recommendations: typing.Union[MetaOapg.properties.recommendations, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + referencePeriod: typing.Union[MetaOapg.properties.referencePeriod, str, schemas.Unset] = schemas.unset, + referenceValue: typing.Union[MetaOapg.properties.referenceValue, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + sourceCount: typing.Union[MetaOapg.properties.sourceCount, decimal.Decimal, int, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + widgetId: typing.Union[MetaOapg.properties.widgetId, str, schemas.Unset] = schemas.unset, + widgetName: typing.Union[MetaOapg.properties.widgetName, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + comparisonType=comparisonType, + title=title, + direction=direction, + analyticalDashboardTitle=analyticalDashboardTitle, + analyzedPeriod=analyzedPeriod, + analyzedValue=analyzedValue, + areRelationsValid=areRelationsValid, + confidence=confidence, + createdAt=createdAt, + description=description, + metricTitle=metricTitle, + recommendations=recommendations, + referencePeriod=referencePeriod, + referenceValue=referenceValue, + sourceCount=sourceCount, + tags=tags, + widgetId=widgetId, + widgetName=widgetName, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def KNOWLEDGE_RECOMMENDATION(cls): + return cls("knowledgeRecommendation") + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class origin( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "originType", + "originId", + } + + class properties: + originId = schemas.StrSchema + + + class originType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") + + @schemas.classproperty + def PARENT(cls): + return cls("PARENT") + __annotations__ = { + "originId": originId, + "originType": originType, + } + + originType: MetaOapg.properties.originType + originId: MetaOapg.properties.originId + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + originType: typing.Union[MetaOapg.properties.originType, str, ], + originId: typing.Union[MetaOapg.properties.originId, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'origin': + return super().__new__( + cls, + *_args, + originType=originType, + originId=originId, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "origin": origin, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["origin"]) -> MetaOapg.properties.origin: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["origin"]) -> typing.Union[MetaOapg.properties.origin, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + origin: typing.Union[MetaOapg.properties.origin, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + origin=origin, + _configuration=_configuration, + **kwargs, + ) + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class analyticalDashboard( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAnalyticalDashboardToOneLinkage']: + return JsonApiAnalyticalDashboardToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAnalyticalDashboardToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAnalyticalDashboardToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'analyticalDashboard': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class metric( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiMetricToOneLinkage']: + return JsonApiMetricToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiMetricToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiMetricToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'metric': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "analyticalDashboard": analyticalDashboard, + "metric": metric, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> MetaOapg.properties.analyticalDashboard: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metric"]) -> MetaOapg.properties.metric: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "metric", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union[MetaOapg.properties.analyticalDashboard, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metric"]) -> typing.Union[MetaOapg.properties.metric, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "metric", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + analyticalDashboard: typing.Union[MetaOapg.properties.analyticalDashboard, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + metric: typing.Union[MetaOapg.properties.metric, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + analyticalDashboard=analyticalDashboard, + metric=metric, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + "meta": meta, + "relationships": relationships, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "meta", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "meta", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiKnowledgeRecommendationOut': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + meta=meta, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.model.json_api_metric_to_one_linkage import JsonApiMetricToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_document.pyi new file mode 100644 index 000000000..7119b5ba2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_document.pyi @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiKnowledgeRecommendationOutDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiKnowledgeRecommendationOut']: + return JsonApiKnowledgeRecommendationOut + + + class included( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiKnowledgeRecommendationOutIncludes']: + return JsonApiKnowledgeRecommendationOutIncludes + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiKnowledgeRecommendationOutIncludes'], typing.List['JsonApiKnowledgeRecommendationOutIncludes']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'included': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiKnowledgeRecommendationOutIncludes': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ObjectLinks']: + return ObjectLinks + __annotations__ = { + "data": data, + "included": included, + "links": links, + } + + data: 'JsonApiKnowledgeRecommendationOut' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiKnowledgeRecommendationOut': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiKnowledgeRecommendationOut': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiKnowledgeRecommendationOut', + included: typing.Union[MetaOapg.properties.included, list, tuple, schemas.Unset] = schemas.unset, + links: typing.Union['ObjectLinks', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiKnowledgeRecommendationOutDocument': + return super().__new__( + cls, + *_args, + data=data, + included=included, + links=links, + _configuration=_configuration, + **kwargs, + ) + +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 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_includes.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_includes.pyi new file mode 100644 index 000000000..d71704037 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_includes.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiKnowledgeRecommendationOutIncludes( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + JsonApiMetricOutWithLinks, + JsonApiAnalyticalDashboardOutWithLinks, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiKnowledgeRecommendationOutIncludes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks +from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_list.pyi new file mode 100644 index 000000000..f8376c02c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_list.pyi @@ -0,0 +1,226 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiKnowledgeRecommendationOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiKnowledgeRecommendationOutWithLinks']: + return JsonApiKnowledgeRecommendationOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiKnowledgeRecommendationOutWithLinks'], typing.List['JsonApiKnowledgeRecommendationOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiKnowledgeRecommendationOutWithLinks': + return super().__getitem__(i) + + + class included( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiKnowledgeRecommendationOutIncludes']: + return JsonApiKnowledgeRecommendationOutIncludes + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiKnowledgeRecommendationOutIncludes'], typing.List['JsonApiKnowledgeRecommendationOutIncludes']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'included': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiKnowledgeRecommendationOutIncludes': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "included": included, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + included: typing.Union[MetaOapg.properties.included, list, tuple, schemas.Unset] = schemas.unset, + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiKnowledgeRecommendationOutList': + return super().__new__( + cls, + *_args, + data=data, + included=included, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_knowledge_recommendation_out_includes import JsonApiKnowledgeRecommendationOutIncludes +from gooddata_api_client.model.json_api_knowledge_recommendation_out_with_links import JsonApiKnowledgeRecommendationOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_with_links.pyi new file mode 100644 index 000000000..b6a714d21 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiKnowledgeRecommendationOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiKnowledgeRecommendationOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiKnowledgeRecommendationOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_knowledge_recommendation_out import JsonApiKnowledgeRecommendationOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_patch.pyi new file mode 100644 index 000000000..52da6d87e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_patch.pyi @@ -0,0 +1,613 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiKnowledgeRecommendationPatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching knowledgeRecommendation entity. + """ + + + class MetaOapg: + required = { + "relationships", + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class analyticalDashboardTitle( + schemas.StrSchema + ): + pass + + + class analyzedPeriod( + schemas.StrSchema + ): + pass + analyzedValue = schemas.AnyTypeSchema + areRelationsValid = schemas.BoolSchema + + + class comparisonType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MONTH(cls): + return cls("MONTH") + + @schemas.classproperty + def QUARTER(cls): + return cls("QUARTER") + + @schemas.classproperty + def YEAR(cls): + return cls("YEAR") + confidence = schemas.AnyTypeSchema + + + class description( + schemas.StrSchema + ): + pass + + + class direction( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INCREASED(cls): + return cls("INCREASED") + + @schemas.classproperty + def DECREASED(cls): + return cls("DECREASED") + + + class metricTitle( + schemas.StrSchema + ): + pass + recommendations = schemas.DictSchema + + + class referencePeriod( + schemas.StrSchema + ): + pass + referenceValue = schemas.AnyTypeSchema + sourceCount = schemas.Int32Schema + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + + + class widgetId( + schemas.StrSchema + ): + pass + + + class widgetName( + schemas.StrSchema + ): + pass + __annotations__ = { + "analyticalDashboardTitle": analyticalDashboardTitle, + "analyzedPeriod": analyzedPeriod, + "analyzedValue": analyzedValue, + "areRelationsValid": areRelationsValid, + "comparisonType": comparisonType, + "confidence": confidence, + "description": description, + "direction": direction, + "metricTitle": metricTitle, + "recommendations": recommendations, + "referencePeriod": referencePeriod, + "referenceValue": referenceValue, + "sourceCount": sourceCount, + "tags": tags, + "title": title, + "widgetId": widgetId, + "widgetName": widgetName, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboardTitle"]) -> MetaOapg.properties.analyticalDashboardTitle: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyzedPeriod"]) -> MetaOapg.properties.analyzedPeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyzedValue"]) -> MetaOapg.properties.analyzedValue: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["comparisonType"]) -> MetaOapg.properties.comparisonType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["confidence"]) -> MetaOapg.properties.confidence: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["direction"]) -> MetaOapg.properties.direction: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metricTitle"]) -> MetaOapg.properties.metricTitle: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["recommendations"]) -> MetaOapg.properties.recommendations: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["referencePeriod"]) -> MetaOapg.properties.referencePeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["referenceValue"]) -> MetaOapg.properties.referenceValue: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sourceCount"]) -> MetaOapg.properties.sourceCount: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetId"]) -> MetaOapg.properties.widgetId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetName"]) -> MetaOapg.properties.widgetName: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboardTitle", "analyzedPeriod", "analyzedValue", "areRelationsValid", "comparisonType", "confidence", "description", "direction", "metricTitle", "recommendations", "referencePeriod", "referenceValue", "sourceCount", "tags", "title", "widgetId", "widgetName", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboardTitle"]) -> typing.Union[MetaOapg.properties.analyticalDashboardTitle, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyzedPeriod"]) -> typing.Union[MetaOapg.properties.analyzedPeriod, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyzedValue"]) -> typing.Union[MetaOapg.properties.analyzedValue, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["comparisonType"]) -> typing.Union[MetaOapg.properties.comparisonType, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["confidence"]) -> typing.Union[MetaOapg.properties.confidence, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["direction"]) -> typing.Union[MetaOapg.properties.direction, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metricTitle"]) -> typing.Union[MetaOapg.properties.metricTitle, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["recommendations"]) -> typing.Union[MetaOapg.properties.recommendations, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["referencePeriod"]) -> typing.Union[MetaOapg.properties.referencePeriod, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["referenceValue"]) -> typing.Union[MetaOapg.properties.referenceValue, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sourceCount"]) -> typing.Union[MetaOapg.properties.sourceCount, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetId"]) -> typing.Union[MetaOapg.properties.widgetId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetName"]) -> typing.Union[MetaOapg.properties.widgetName, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboardTitle", "analyzedPeriod", "analyzedValue", "areRelationsValid", "comparisonType", "confidence", "description", "direction", "metricTitle", "recommendations", "referencePeriod", "referenceValue", "sourceCount", "tags", "title", "widgetId", "widgetName", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + analyticalDashboardTitle: typing.Union[MetaOapg.properties.analyticalDashboardTitle, str, schemas.Unset] = schemas.unset, + analyzedPeriod: typing.Union[MetaOapg.properties.analyzedPeriod, str, schemas.Unset] = schemas.unset, + analyzedValue: typing.Union[MetaOapg.properties.analyzedValue, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + comparisonType: typing.Union[MetaOapg.properties.comparisonType, str, schemas.Unset] = schemas.unset, + confidence: typing.Union[MetaOapg.properties.confidence, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + direction: typing.Union[MetaOapg.properties.direction, str, schemas.Unset] = schemas.unset, + metricTitle: typing.Union[MetaOapg.properties.metricTitle, str, schemas.Unset] = schemas.unset, + recommendations: typing.Union[MetaOapg.properties.recommendations, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + referencePeriod: typing.Union[MetaOapg.properties.referencePeriod, str, schemas.Unset] = schemas.unset, + referenceValue: typing.Union[MetaOapg.properties.referenceValue, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + sourceCount: typing.Union[MetaOapg.properties.sourceCount, decimal.Decimal, int, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + widgetId: typing.Union[MetaOapg.properties.widgetId, str, schemas.Unset] = schemas.unset, + widgetName: typing.Union[MetaOapg.properties.widgetName, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + analyticalDashboardTitle=analyticalDashboardTitle, + analyzedPeriod=analyzedPeriod, + analyzedValue=analyzedValue, + areRelationsValid=areRelationsValid, + comparisonType=comparisonType, + confidence=confidence, + description=description, + direction=direction, + metricTitle=metricTitle, + recommendations=recommendations, + referencePeriod=referencePeriod, + referenceValue=referenceValue, + sourceCount=sourceCount, + tags=tags, + title=title, + widgetId=widgetId, + widgetName=widgetName, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class analyticalDashboard( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAnalyticalDashboardToOneLinkage']: + return JsonApiAnalyticalDashboardToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAnalyticalDashboardToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAnalyticalDashboardToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'analyticalDashboard': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class metric( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiMetricToOneLinkage']: + return JsonApiMetricToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiMetricToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiMetricToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'metric': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "analyticalDashboard": analyticalDashboard, + "metric": metric, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> MetaOapg.properties.analyticalDashboard: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metric"]) -> MetaOapg.properties.metric: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "metric", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union[MetaOapg.properties.analyticalDashboard, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metric"]) -> typing.Union[MetaOapg.properties.metric, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "metric", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + analyticalDashboard: typing.Union[MetaOapg.properties.analyticalDashboard, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + metric: typing.Union[MetaOapg.properties.metric, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + analyticalDashboard=analyticalDashboard, + metric=metric, + _configuration=_configuration, + **kwargs, + ) + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def KNOWLEDGE_RECOMMENDATION(cls): + return cls("knowledgeRecommendation") + __annotations__ = { + "attributes": attributes, + "id": id, + "relationships": relationships, + "type": type, + } + + relationships: MetaOapg.properties.relationships + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "relationships", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "relationships", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiKnowledgeRecommendationPatch': + return super().__new__( + cls, + *_args, + relationships=relationships, + attributes=attributes, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.model.json_api_metric_to_one_linkage import JsonApiMetricToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_patch_document.pyi new file mode 100644 index 000000000..f8b9f5363 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiKnowledgeRecommendationPatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiKnowledgeRecommendationPatch']: + return JsonApiKnowledgeRecommendationPatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiKnowledgeRecommendationPatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiKnowledgeRecommendationPatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiKnowledgeRecommendationPatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiKnowledgeRecommendationPatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiKnowledgeRecommendationPatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_knowledge_recommendation_patch import JsonApiKnowledgeRecommendationPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_post_optional_id.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_post_optional_id.pyi new file mode 100644 index 000000000..9f53d5696 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_post_optional_id.pyi @@ -0,0 +1,625 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiKnowledgeRecommendationPostOptionalId( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of knowledgeRecommendation entity. + """ + + + class MetaOapg: + required = { + "relationships", + "attributes", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "comparisonType", + "title", + "direction", + } + + class properties: + + + class analyticalDashboardTitle( + schemas.StrSchema + ): + pass + + + class analyzedPeriod( + schemas.StrSchema + ): + pass + analyzedValue = schemas.AnyTypeSchema + areRelationsValid = schemas.BoolSchema + + + class comparisonType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MONTH(cls): + return cls("MONTH") + + @schemas.classproperty + def QUARTER(cls): + return cls("QUARTER") + + @schemas.classproperty + def YEAR(cls): + return cls("YEAR") + confidence = schemas.AnyTypeSchema + + + class description( + schemas.StrSchema + ): + pass + + + class direction( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INCREASED(cls): + return cls("INCREASED") + + @schemas.classproperty + def DECREASED(cls): + return cls("DECREASED") + + + class metricTitle( + schemas.StrSchema + ): + pass + recommendations = schemas.DictSchema + + + class referencePeriod( + schemas.StrSchema + ): + pass + referenceValue = schemas.AnyTypeSchema + sourceCount = schemas.Int32Schema + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + + + class widgetId( + schemas.StrSchema + ): + pass + + + class widgetName( + schemas.StrSchema + ): + pass + __annotations__ = { + "analyticalDashboardTitle": analyticalDashboardTitle, + "analyzedPeriod": analyzedPeriod, + "analyzedValue": analyzedValue, + "areRelationsValid": areRelationsValid, + "comparisonType": comparisonType, + "confidence": confidence, + "description": description, + "direction": direction, + "metricTitle": metricTitle, + "recommendations": recommendations, + "referencePeriod": referencePeriod, + "referenceValue": referenceValue, + "sourceCount": sourceCount, + "tags": tags, + "title": title, + "widgetId": widgetId, + "widgetName": widgetName, + } + + comparisonType: MetaOapg.properties.comparisonType + title: MetaOapg.properties.title + direction: MetaOapg.properties.direction + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboardTitle"]) -> MetaOapg.properties.analyticalDashboardTitle: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyzedPeriod"]) -> MetaOapg.properties.analyzedPeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyzedValue"]) -> MetaOapg.properties.analyzedValue: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["comparisonType"]) -> MetaOapg.properties.comparisonType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["confidence"]) -> MetaOapg.properties.confidence: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["direction"]) -> MetaOapg.properties.direction: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metricTitle"]) -> MetaOapg.properties.metricTitle: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["recommendations"]) -> MetaOapg.properties.recommendations: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["referencePeriod"]) -> MetaOapg.properties.referencePeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["referenceValue"]) -> MetaOapg.properties.referenceValue: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sourceCount"]) -> MetaOapg.properties.sourceCount: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetId"]) -> MetaOapg.properties.widgetId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetName"]) -> MetaOapg.properties.widgetName: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboardTitle", "analyzedPeriod", "analyzedValue", "areRelationsValid", "comparisonType", "confidence", "description", "direction", "metricTitle", "recommendations", "referencePeriod", "referenceValue", "sourceCount", "tags", "title", "widgetId", "widgetName", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboardTitle"]) -> typing.Union[MetaOapg.properties.analyticalDashboardTitle, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyzedPeriod"]) -> typing.Union[MetaOapg.properties.analyzedPeriod, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyzedValue"]) -> typing.Union[MetaOapg.properties.analyzedValue, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["comparisonType"]) -> MetaOapg.properties.comparisonType: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["confidence"]) -> typing.Union[MetaOapg.properties.confidence, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["direction"]) -> MetaOapg.properties.direction: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metricTitle"]) -> typing.Union[MetaOapg.properties.metricTitle, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["recommendations"]) -> typing.Union[MetaOapg.properties.recommendations, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["referencePeriod"]) -> typing.Union[MetaOapg.properties.referencePeriod, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["referenceValue"]) -> typing.Union[MetaOapg.properties.referenceValue, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sourceCount"]) -> typing.Union[MetaOapg.properties.sourceCount, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetId"]) -> typing.Union[MetaOapg.properties.widgetId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetName"]) -> typing.Union[MetaOapg.properties.widgetName, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboardTitle", "analyzedPeriod", "analyzedValue", "areRelationsValid", "comparisonType", "confidence", "description", "direction", "metricTitle", "recommendations", "referencePeriod", "referenceValue", "sourceCount", "tags", "title", "widgetId", "widgetName", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + comparisonType: typing.Union[MetaOapg.properties.comparisonType, str, ], + title: typing.Union[MetaOapg.properties.title, str, ], + direction: typing.Union[MetaOapg.properties.direction, str, ], + analyticalDashboardTitle: typing.Union[MetaOapg.properties.analyticalDashboardTitle, str, schemas.Unset] = schemas.unset, + analyzedPeriod: typing.Union[MetaOapg.properties.analyzedPeriod, str, schemas.Unset] = schemas.unset, + analyzedValue: typing.Union[MetaOapg.properties.analyzedValue, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + confidence: typing.Union[MetaOapg.properties.confidence, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + metricTitle: typing.Union[MetaOapg.properties.metricTitle, str, schemas.Unset] = schemas.unset, + recommendations: typing.Union[MetaOapg.properties.recommendations, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + referencePeriod: typing.Union[MetaOapg.properties.referencePeriod, str, schemas.Unset] = schemas.unset, + referenceValue: typing.Union[MetaOapg.properties.referenceValue, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + sourceCount: typing.Union[MetaOapg.properties.sourceCount, decimal.Decimal, int, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + widgetId: typing.Union[MetaOapg.properties.widgetId, str, schemas.Unset] = schemas.unset, + widgetName: typing.Union[MetaOapg.properties.widgetName, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + comparisonType=comparisonType, + title=title, + direction=direction, + analyticalDashboardTitle=analyticalDashboardTitle, + analyzedPeriod=analyzedPeriod, + analyzedValue=analyzedValue, + areRelationsValid=areRelationsValid, + confidence=confidence, + description=description, + metricTitle=metricTitle, + recommendations=recommendations, + referencePeriod=referencePeriod, + referenceValue=referenceValue, + sourceCount=sourceCount, + tags=tags, + widgetId=widgetId, + widgetName=widgetName, + _configuration=_configuration, + **kwargs, + ) + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "metric", + } + + class properties: + + + class analyticalDashboard( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAnalyticalDashboardToOneLinkage']: + return JsonApiAnalyticalDashboardToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAnalyticalDashboardToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAnalyticalDashboardToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'analyticalDashboard': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class metric( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiMetricToOneLinkage']: + return JsonApiMetricToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiMetricToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMetricToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiMetricToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'metric': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "analyticalDashboard": analyticalDashboard, + "metric": metric, + } + + metric: MetaOapg.properties.metric + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> MetaOapg.properties.analyticalDashboard: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metric"]) -> MetaOapg.properties.metric: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "metric", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union[MetaOapg.properties.analyticalDashboard, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metric"]) -> MetaOapg.properties.metric: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "metric", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + metric: typing.Union[MetaOapg.properties.metric, dict, frozendict.frozendict, ], + analyticalDashboard: typing.Union[MetaOapg.properties.analyticalDashboard, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + metric=metric, + analyticalDashboard=analyticalDashboard, + _configuration=_configuration, + **kwargs, + ) + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def KNOWLEDGE_RECOMMENDATION(cls): + return cls("knowledgeRecommendation") + + + class id( + schemas.StrSchema + ): + pass + __annotations__ = { + "attributes": attributes, + "relationships": relationships, + "type": type, + "id": id, + } + + relationships: MetaOapg.properties.relationships + attributes: MetaOapg.properties.attributes + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "relationships", "type", "id", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> typing.Union[MetaOapg.properties.id, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "relationships", "type", "id", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + id: typing.Union[MetaOapg.properties.id, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiKnowledgeRecommendationPostOptionalId': + return super().__new__( + cls, + *_args, + relationships=relationships, + attributes=attributes, + type=type, + id=id, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.model.json_api_metric_to_one_linkage import JsonApiMetricToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_post_optional_id_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_post_optional_id_document.pyi new file mode 100644 index 000000000..87d443b91 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_post_optional_id_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiKnowledgeRecommendationPostOptionalIdDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiKnowledgeRecommendationPostOptionalId']: + return JsonApiKnowledgeRecommendationPostOptionalId + __annotations__ = { + "data": data, + } + + data: 'JsonApiKnowledgeRecommendationPostOptionalId' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiKnowledgeRecommendationPostOptionalId': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiKnowledgeRecommendationPostOptionalId': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiKnowledgeRecommendationPostOptionalId', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiKnowledgeRecommendationPostOptionalIdDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_knowledge_recommendation_post_optional_id import JsonApiKnowledgeRecommendationPostOptionalId diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_label_patch.pyi new file mode 100644 index 000000000..e16ea7c66 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_label_patch.pyi @@ -0,0 +1,223 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLabelPatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching label entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def LABEL(cls): + return cls("label") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class description( + schemas.StrSchema + ): + pass + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "description": description, + "tags": tags, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["description", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["description", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + description=description, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLabelPatch': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_label_patch_document.pyi new file mode 100644 index 000000000..b21ecefc1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_label_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLabelPatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiLabelPatch']: + return JsonApiLabelPatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiLabelPatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelPatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLabelPatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiLabelPatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLabelPatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_label_patch import JsonApiLabelPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_in.pyi new file mode 100644 index 000000000..9890de11f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_in.pyi @@ -0,0 +1,302 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLlmEndpointIn( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of llmEndpoint entity. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "title", + "token", + } + + class properties: + + + class baseUrl( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'baseUrl': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class llmModel( + schemas.StrSchema + ): + pass + + + class llmOrganization( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'llmOrganization': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class provider( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def OPENAI(cls): + return cls("OPENAI") + + @schemas.classproperty + def AZURE_OPENAI(cls): + return cls("AZURE_OPENAI") + + + class title( + schemas.StrSchema + ): + pass + + + class token( + schemas.StrSchema + ): + pass + __annotations__ = { + "baseUrl": baseUrl, + "llmModel": llmModel, + "llmOrganization": llmOrganization, + "provider": provider, + "title": title, + "token": token, + } + + title: MetaOapg.properties.title + token: MetaOapg.properties.token + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["baseUrl"]) -> MetaOapg.properties.baseUrl: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["llmModel"]) -> MetaOapg.properties.llmModel: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["llmOrganization"]) -> MetaOapg.properties.llmOrganization: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["provider"]) -> MetaOapg.properties.provider: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["token"]) -> MetaOapg.properties.token: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["baseUrl", "llmModel", "llmOrganization", "provider", "title", "token", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["baseUrl"]) -> typing.Union[MetaOapg.properties.baseUrl, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["llmModel"]) -> typing.Union[MetaOapg.properties.llmModel, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["llmOrganization"]) -> typing.Union[MetaOapg.properties.llmOrganization, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["provider"]) -> typing.Union[MetaOapg.properties.provider, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["token"]) -> MetaOapg.properties.token: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["baseUrl", "llmModel", "llmOrganization", "provider", "title", "token", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + title: typing.Union[MetaOapg.properties.title, str, ], + token: typing.Union[MetaOapg.properties.token, str, ], + baseUrl: typing.Union[MetaOapg.properties.baseUrl, None, str, schemas.Unset] = schemas.unset, + llmModel: typing.Union[MetaOapg.properties.llmModel, str, schemas.Unset] = schemas.unset, + llmOrganization: typing.Union[MetaOapg.properties.llmOrganization, None, str, schemas.Unset] = schemas.unset, + provider: typing.Union[MetaOapg.properties.provider, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + title=title, + token=token, + baseUrl=baseUrl, + llmModel=llmModel, + llmOrganization=llmOrganization, + provider=provider, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def LLM_ENDPOINT(cls): + return cls("llmEndpoint") + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLlmEndpointIn': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_in_document.pyi new file mode 100644 index 000000000..d6fd3ddc0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_in_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLlmEndpointInDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiLlmEndpointIn']: + return JsonApiLlmEndpointIn + __annotations__ = { + "data": data, + } + + data: 'JsonApiLlmEndpointIn' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLlmEndpointIn': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLlmEndpointIn': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiLlmEndpointIn', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLlmEndpointInDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_llm_endpoint_in import JsonApiLlmEndpointIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out.pyi new file mode 100644 index 000000000..c76803090 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out.pyi @@ -0,0 +1,285 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLlmEndpointOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of llmEndpoint entity. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "title", + } + + class properties: + + + class baseUrl( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'baseUrl': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class llmModel( + schemas.StrSchema + ): + pass + + + class llmOrganization( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'llmOrganization': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class provider( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def OPENAI(cls): + return cls("OPENAI") + + @schemas.classproperty + def AZURE_OPENAI(cls): + return cls("AZURE_OPENAI") + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "baseUrl": baseUrl, + "llmModel": llmModel, + "llmOrganization": llmOrganization, + "provider": provider, + "title": title, + } + + title: MetaOapg.properties.title + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["baseUrl"]) -> MetaOapg.properties.baseUrl: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["llmModel"]) -> MetaOapg.properties.llmModel: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["llmOrganization"]) -> MetaOapg.properties.llmOrganization: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["provider"]) -> MetaOapg.properties.provider: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["baseUrl", "llmModel", "llmOrganization", "provider", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["baseUrl"]) -> typing.Union[MetaOapg.properties.baseUrl, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["llmModel"]) -> typing.Union[MetaOapg.properties.llmModel, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["llmOrganization"]) -> typing.Union[MetaOapg.properties.llmOrganization, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["provider"]) -> typing.Union[MetaOapg.properties.provider, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["baseUrl", "llmModel", "llmOrganization", "provider", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + title: typing.Union[MetaOapg.properties.title, str, ], + baseUrl: typing.Union[MetaOapg.properties.baseUrl, None, str, schemas.Unset] = schemas.unset, + llmModel: typing.Union[MetaOapg.properties.llmModel, str, schemas.Unset] = schemas.unset, + llmOrganization: typing.Union[MetaOapg.properties.llmOrganization, None, str, schemas.Unset] = schemas.unset, + provider: typing.Union[MetaOapg.properties.provider, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + title=title, + baseUrl=baseUrl, + llmModel=llmModel, + llmOrganization=llmOrganization, + provider=provider, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def LLM_ENDPOINT(cls): + return cls("llmEndpoint") + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLlmEndpointOut': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_document.pyi new file mode 100644 index 000000000..93128219d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_document.pyi @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLlmEndpointOutDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiLlmEndpointOut']: + return JsonApiLlmEndpointOut + + @staticmethod + def links() -> typing.Type['ObjectLinks']: + return ObjectLinks + __annotations__ = { + "data": data, + "links": links, + } + + data: 'JsonApiLlmEndpointOut' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLlmEndpointOut': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLlmEndpointOut': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiLlmEndpointOut', + links: typing.Union['ObjectLinks', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLlmEndpointOutDocument': + return super().__new__( + cls, + *_args, + data=data, + links=links, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_llm_endpoint_out import JsonApiLlmEndpointOut +from gooddata_api_client.model.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_list.pyi new file mode 100644 index 000000000..b23e82c89 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_list.pyi @@ -0,0 +1,190 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLlmEndpointOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiLlmEndpointOutWithLinks']: + return JsonApiLlmEndpointOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiLlmEndpointOutWithLinks'], typing.List['JsonApiLlmEndpointOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiLlmEndpointOutWithLinks': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLlmEndpointOutList': + return super().__new__( + cls, + *_args, + data=data, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_llm_endpoint_out_with_links import JsonApiLlmEndpointOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_with_links.pyi new file mode 100644 index 000000000..aceb2a3f9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLlmEndpointOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiLlmEndpointOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLlmEndpointOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_llm_endpoint_out import JsonApiLlmEndpointOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_patch.pyi new file mode 100644 index 000000000..688e3c1aa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_patch.pyi @@ -0,0 +1,295 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLlmEndpointPatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching llmEndpoint entity. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class baseUrl( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'baseUrl': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class llmModel( + schemas.StrSchema + ): + pass + + + class llmOrganization( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'llmOrganization': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class provider( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def OPENAI(cls): + return cls("OPENAI") + + @schemas.classproperty + def AZURE_OPENAI(cls): + return cls("AZURE_OPENAI") + + + class title( + schemas.StrSchema + ): + pass + + + class token( + schemas.StrSchema + ): + pass + __annotations__ = { + "baseUrl": baseUrl, + "llmModel": llmModel, + "llmOrganization": llmOrganization, + "provider": provider, + "title": title, + "token": token, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["baseUrl"]) -> MetaOapg.properties.baseUrl: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["llmModel"]) -> MetaOapg.properties.llmModel: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["llmOrganization"]) -> MetaOapg.properties.llmOrganization: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["provider"]) -> MetaOapg.properties.provider: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["token"]) -> MetaOapg.properties.token: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["baseUrl", "llmModel", "llmOrganization", "provider", "title", "token", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["baseUrl"]) -> typing.Union[MetaOapg.properties.baseUrl, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["llmModel"]) -> typing.Union[MetaOapg.properties.llmModel, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["llmOrganization"]) -> typing.Union[MetaOapg.properties.llmOrganization, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["provider"]) -> typing.Union[MetaOapg.properties.provider, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["token"]) -> typing.Union[MetaOapg.properties.token, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["baseUrl", "llmModel", "llmOrganization", "provider", "title", "token", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + baseUrl: typing.Union[MetaOapg.properties.baseUrl, None, str, schemas.Unset] = schemas.unset, + llmModel: typing.Union[MetaOapg.properties.llmModel, str, schemas.Unset] = schemas.unset, + llmOrganization: typing.Union[MetaOapg.properties.llmOrganization, None, str, schemas.Unset] = schemas.unset, + provider: typing.Union[MetaOapg.properties.provider, str, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + token: typing.Union[MetaOapg.properties.token, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + baseUrl=baseUrl, + llmModel=llmModel, + llmOrganization=llmOrganization, + provider=provider, + title=title, + token=token, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def LLM_ENDPOINT(cls): + return cls("llmEndpoint") + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLlmEndpointPatch': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_patch_document.pyi new file mode 100644 index 000000000..8af80acda --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_endpoint_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLlmEndpointPatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiLlmEndpointPatch']: + return JsonApiLlmEndpointPatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiLlmEndpointPatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLlmEndpointPatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLlmEndpointPatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiLlmEndpointPatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLlmEndpointPatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_llm_endpoint_patch import JsonApiLlmEndpointPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in.py new file mode 100644 index 000000000..7e7e92d29 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_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_llm_provider_in_attributes import JsonApiLlmProviderInAttributes + globals()['JsonApiLlmProviderInAttributes'] = JsonApiLlmProviderInAttributes + + +class JsonApiLlmProviderIn(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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',): { + 'LLMPROVIDER': "llmProvider", + }, + } + + 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': (JsonApiLlmProviderInAttributes,), # 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 + """JsonApiLlmProviderIn - a model defined in OpenAPI + + Args: + attributes (JsonApiLlmProviderInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "llmProvider", must be one of ["llmProvider", ] # 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', "llmProvider") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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 + """JsonApiLlmProviderIn - a model defined in OpenAPI + + Args: + attributes (JsonApiLlmProviderInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "llmProvider", must be one of ["llmProvider", ] # 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', "llmProvider") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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_llm_provider_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in.pyi new file mode 100644 index 000000000..65d39da4d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in.pyi @@ -0,0 +1,454 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLlmProviderIn( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + LLM Provider configuration for connecting to LLM services. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "models", + "providerConfig", + } + + class properties: + + + class defaultModelId( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'defaultModelId': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class description( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'description': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class models( + schemas.ListBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneTupleMixin + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "id", + "family", + } + + class properties: + + + class family( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def OPENAI(cls): + return cls("OPENAI") + + @schemas.classproperty + def ANTHROPIC(cls): + return cls("ANTHROPIC") + + @schemas.classproperty + def META(cls): + return cls("META") + + @schemas.classproperty + def MISTRAL(cls): + return cls("MISTRAL") + + @schemas.classproperty + def AMAZON(cls): + return cls("AMAZON") + + @schemas.classproperty + def GOOGLE(cls): + return cls("GOOGLE") + + @schemas.classproperty + def COHERE(cls): + return cls("COHERE") + + + class id( + schemas.StrSchema + ): + pass + __annotations__ = { + "family": family, + "id": id, + } + + id: MetaOapg.properties.id + family: MetaOapg.properties.family + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["family"]) -> MetaOapg.properties.family: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["family", "id", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["family"]) -> MetaOapg.properties.family: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["family", "id", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + family: typing.Union[MetaOapg.properties.family, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + id=id, + family=family, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[list, tuple, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'models': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class name( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'name': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class providerConfig( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AwsBedrockProviderConfig, + AzureFoundryProviderConfig, + OpenAIProviderConfig, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'providerConfig': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "defaultModelId": defaultModelId, + "description": description, + "models": models, + "name": name, + "providerConfig": providerConfig, + } + + models: MetaOapg.properties.models + providerConfig: MetaOapg.properties.providerConfig + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["defaultModelId"]) -> MetaOapg.properties.defaultModelId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["models"]) -> MetaOapg.properties.models: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["providerConfig"]) -> MetaOapg.properties.providerConfig: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["defaultModelId", "description", "models", "name", "providerConfig", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["defaultModelId"]) -> typing.Union[MetaOapg.properties.defaultModelId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["models"]) -> MetaOapg.properties.models: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["providerConfig"]) -> MetaOapg.properties.providerConfig: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["defaultModelId", "description", "models", "name", "providerConfig", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + models: typing.Union[MetaOapg.properties.models, list, tuple, None, ], + providerConfig: typing.Union[MetaOapg.properties.providerConfig, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + defaultModelId: typing.Union[MetaOapg.properties.defaultModelId, None, str, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, None, str, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, None, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + models=models, + providerConfig=providerConfig, + defaultModelId=defaultModelId, + description=description, + name=name, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def LLM_PROVIDER(cls): + return cls("llmProvider") + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLlmProviderIn': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aws_bedrock_provider_config import AwsBedrockProviderConfig +from gooddata_api_client.model.azure_foundry_provider_config import AzureFoundryProviderConfig +from gooddata_api_client.model.open_ai_provider_config import OpenAIProviderConfig diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes.py new file mode 100644 index 000000000..3425ffeda --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes.py @@ -0,0 +1,305 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_llm_provider_in_attributes_models_inner import JsonApiLlmProviderInAttributesModelsInner + from gooddata_api_client.model.json_api_llm_provider_in_attributes_provider_config import JsonApiLlmProviderInAttributesProviderConfig + globals()['JsonApiLlmProviderInAttributesModelsInner'] = JsonApiLlmProviderInAttributesModelsInner + globals()['JsonApiLlmProviderInAttributesProviderConfig'] = JsonApiLlmProviderInAttributesProviderConfig + + +class JsonApiLlmProviderInAttributes(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 = { + ('default_model_id',): { + 'max_length': 255, + }, + ('description',): { + 'max_length': 10000, + }, + ('name',): { + 'max_length': 255, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'models': ([JsonApiLlmProviderInAttributesModelsInner], none_type,), # noqa: E501 + 'provider_config': (JsonApiLlmProviderInAttributesProviderConfig,), # noqa: E501 + 'default_model_id': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'models': 'models', # noqa: E501 + 'provider_config': 'providerConfig', # noqa: E501 + 'default_model_id': 'defaultModelId', # noqa: E501 + 'description': 'description', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, models, provider_config, *args, **kwargs): # noqa: E501 + """JsonApiLlmProviderInAttributes - a model defined in OpenAPI + + Args: + models ([JsonApiLlmProviderInAttributesModelsInner], none_type): List of LLM models available for this provider. + provider_config (JsonApiLlmProviderInAttributesProviderConfig): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + default_model_id (str, none_type): ID of the default model to use from the models list.. [optional] # noqa: E501 + description (str, none_type): Description of the LLM Provider.. [optional] # noqa: E501 + name (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.models = models + self.provider_config = provider_config + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, models, provider_config, *args, **kwargs): # noqa: E501 + """JsonApiLlmProviderInAttributes - a model defined in OpenAPI + + Args: + models ([JsonApiLlmProviderInAttributesModelsInner], none_type): List of LLM models available for this provider. + provider_config (JsonApiLlmProviderInAttributesProviderConfig): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + default_model_id (str, none_type): ID of the default model to use from the models list.. [optional] # noqa: E501 + description (str, none_type): Description of the LLM Provider.. [optional] # noqa: E501 + name (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.models = models + self.provider_config = provider_config + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes_models_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes_models_inner.py new file mode 100644 index 000000000..0ff9244c7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes_models_inner.py @@ -0,0 +1,288 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class JsonApiLlmProviderInAttributesModelsInner(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('family',): { + 'OPENAI': "OPENAI", + 'ANTHROPIC': "ANTHROPIC", + 'META': "META", + 'MISTRAL': "MISTRAL", + 'AMAZON': "AMAZON", + 'GOOGLE': "GOOGLE", + 'COHERE': "COHERE", + }, + } + + validations = { + ('id',): { + '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 { + 'family': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'family': 'family', # noqa: E501 + 'id': 'id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, family, id, *args, **kwargs): # noqa: E501 + """JsonApiLlmProviderInAttributesModelsInner - a model defined in OpenAPI + + Args: + family (str): Family of LLM models. + id (str): Unique identifier of the model (e.g., gpt-5.3, claude-4.6). + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.family = family + self.id = 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, family, id, *args, **kwargs): # noqa: E501 + """JsonApiLlmProviderInAttributesModelsInner - a model defined in OpenAPI + + Args: + family (str): Family of LLM models. + id (str): Unique identifier of the model (e.g., gpt-5.3, claude-4.6). + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.family = family + self.id = 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/json_api_llm_provider_in_attributes_provider_config.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes_provider_config.py new file mode 100644 index 000000000..949c97b2a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes_provider_config.py @@ -0,0 +1,363 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.aws_bedrock_provider_config import AwsBedrockProviderConfig + from gooddata_api_client.model.azure_foundry_provider_config import AzureFoundryProviderConfig + from gooddata_api_client.model.open_ai_provider_auth import OpenAiProviderAuth + from gooddata_api_client.model.open_ai_provider_config import OpenAIProviderConfig + globals()['AwsBedrockProviderConfig'] = AwsBedrockProviderConfig + globals()['AzureFoundryProviderConfig'] = AzureFoundryProviderConfig + globals()['OpenAIProviderConfig'] = OpenAIProviderConfig + globals()['OpenAiProviderAuth'] = OpenAiProviderAuth + + +class JsonApiLlmProviderInAttributesProviderConfig(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',): { + 'OPENAI': "OPENAI", + }, + } + + validations = { + ('base_url',): { + 'max_length': 255, + }, + ('organization',): { + 'max_length': 255, + }, + ('region',): { + 'max_length': 255, + }, + ('endpoint',): { + '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 { + 'base_url': (str, none_type,), # noqa: E501 + 'organization': (str, none_type,), # noqa: E501 + 'auth': (OpenAiProviderAuth,), # noqa: E501 + 'region': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'endpoint': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'base_url': 'baseUrl', # noqa: E501 + 'organization': 'organization', # noqa: E501 + 'auth': 'auth', # noqa: E501 + 'region': 'region', # noqa: E501 + 'type': 'type', # noqa: E501 + 'endpoint': 'endpoint', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiLlmProviderInAttributesProviderConfig - 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,) + base_url (str, none_type): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com" # noqa: E501 + organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 + auth (OpenAiProviderAuth): [optional] # noqa: E501 + region (str): AWS region for Bedrock.. [optional] # noqa: E501 + type (str): Provider type.. [optional] if omitted the server will use the default value of "OPENAI" # noqa: E501 + endpoint (str): Azure AI inference endpoint URL.. [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 + """JsonApiLlmProviderInAttributesProviderConfig - 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,) + base_url (str, none_type): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com" # noqa: E501 + organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 + auth (OpenAiProviderAuth): [optional] # noqa: E501 + region (str): AWS region for Bedrock.. [optional] # noqa: E501 + type (str): Provider type.. [optional] if omitted the server will use the default value of "OPENAI" # noqa: E501 + endpoint (str): Azure AI inference endpoint URL.. [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': [ + AwsBedrockProviderConfig, + AzureFoundryProviderConfig, + OpenAIProviderConfig, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_document.py new file mode 100644 index 000000000..57d628b66 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_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_llm_provider_in import JsonApiLlmProviderIn + globals()['JsonApiLlmProviderIn'] = JsonApiLlmProviderIn + + +class JsonApiLlmProviderInDocument(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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': (JsonApiLlmProviderIn,), # 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 + """JsonApiLlmProviderInDocument - a model defined in OpenAPI + + Args: + data (JsonApiLlmProviderIn): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiLlmProviderInDocument - a model defined in OpenAPI + + Args: + data (JsonApiLlmProviderIn): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_llm_provider_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_document.pyi new file mode 100644 index 000000000..209c65fb7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLlmProviderInDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiLlmProviderIn']: + return JsonApiLlmProviderIn + __annotations__ = { + "data": data, + } + + data: 'JsonApiLlmProviderIn' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLlmProviderIn': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLlmProviderIn': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiLlmProviderIn', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLlmProviderInDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_llm_provider_in import JsonApiLlmProviderIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out.py new file mode 100644 index 000000000..c90290459 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out.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_llm_provider_in_attributes import JsonApiLlmProviderInAttributes + globals()['JsonApiLlmProviderInAttributes'] = JsonApiLlmProviderInAttributes + + +class JsonApiLlmProviderOut(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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',): { + 'LLMPROVIDER': "llmProvider", + }, + } + + 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': (JsonApiLlmProviderInAttributes,), # 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 + """JsonApiLlmProviderOut - a model defined in OpenAPI + + Args: + attributes (JsonApiLlmProviderInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "llmProvider", must be one of ["llmProvider", ] # 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', "llmProvider") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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 + """JsonApiLlmProviderOut - a model defined in OpenAPI + + Args: + attributes (JsonApiLlmProviderInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "llmProvider", must be one of ["llmProvider", ] # 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', "llmProvider") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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_llm_provider_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out.pyi new file mode 100644 index 000000000..d0ff1fa20 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out.pyi @@ -0,0 +1,454 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLlmProviderOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + LLM Provider configuration for connecting to LLM services. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "models", + "providerConfig", + } + + class properties: + + + class defaultModelId( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'defaultModelId': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class description( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'description': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class models( + schemas.ListBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneTupleMixin + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "id", + "family", + } + + class properties: + + + class family( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def OPENAI(cls): + return cls("OPENAI") + + @schemas.classproperty + def ANTHROPIC(cls): + return cls("ANTHROPIC") + + @schemas.classproperty + def META(cls): + return cls("META") + + @schemas.classproperty + def MISTRAL(cls): + return cls("MISTRAL") + + @schemas.classproperty + def AMAZON(cls): + return cls("AMAZON") + + @schemas.classproperty + def GOOGLE(cls): + return cls("GOOGLE") + + @schemas.classproperty + def COHERE(cls): + return cls("COHERE") + + + class id( + schemas.StrSchema + ): + pass + __annotations__ = { + "family": family, + "id": id, + } + + id: MetaOapg.properties.id + family: MetaOapg.properties.family + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["family"]) -> MetaOapg.properties.family: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["family", "id", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["family"]) -> MetaOapg.properties.family: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["family", "id", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + family: typing.Union[MetaOapg.properties.family, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + id=id, + family=family, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[list, tuple, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'models': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class name( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'name': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class providerConfig( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AwsBedrockProviderConfig, + AzureFoundryProviderConfig, + OpenAIProviderConfig, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'providerConfig': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "defaultModelId": defaultModelId, + "description": description, + "models": models, + "name": name, + "providerConfig": providerConfig, + } + + models: MetaOapg.properties.models + providerConfig: MetaOapg.properties.providerConfig + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["defaultModelId"]) -> MetaOapg.properties.defaultModelId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["models"]) -> MetaOapg.properties.models: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["providerConfig"]) -> MetaOapg.properties.providerConfig: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["defaultModelId", "description", "models", "name", "providerConfig", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["defaultModelId"]) -> typing.Union[MetaOapg.properties.defaultModelId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["models"]) -> MetaOapg.properties.models: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["providerConfig"]) -> MetaOapg.properties.providerConfig: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["defaultModelId", "description", "models", "name", "providerConfig", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + models: typing.Union[MetaOapg.properties.models, list, tuple, None, ], + providerConfig: typing.Union[MetaOapg.properties.providerConfig, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + defaultModelId: typing.Union[MetaOapg.properties.defaultModelId, None, str, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, None, str, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, None, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + models=models, + providerConfig=providerConfig, + defaultModelId=defaultModelId, + description=description, + name=name, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def LLM_PROVIDER(cls): + return cls("llmProvider") + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLlmProviderOut': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aws_bedrock_provider_config import AwsBedrockProviderConfig +from gooddata_api_client.model.azure_foundry_provider_config import AzureFoundryProviderConfig +from gooddata_api_client.model.open_ai_provider_config import OpenAIProviderConfig diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_document.py new file mode 100644 index 000000000..557cb946a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_document.py @@ -0,0 +1,282 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_llm_provider_out import JsonApiLlmProviderOut + from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiLlmProviderOut'] = JsonApiLlmProviderOut + globals()['ObjectLinks'] = ObjectLinks + + +class JsonApiLlmProviderOutDocument(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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': (JsonApiLlmProviderOut,), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiLlmProviderOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiLlmProviderOut): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + links (ObjectLinks): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, data, *args, **kwargs): # noqa: E501 + """JsonApiLlmProviderOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiLlmProviderOut): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + links (ObjectLinks): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_document.pyi new file mode 100644 index 000000000..a9bd3b419 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_document.pyi @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLlmProviderOutDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiLlmProviderOut']: + return JsonApiLlmProviderOut + + @staticmethod + def links() -> typing.Type['ObjectLinks']: + return ObjectLinks + __annotations__ = { + "data": data, + "links": links, + } + + data: 'JsonApiLlmProviderOut' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLlmProviderOut': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLlmProviderOut': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiLlmProviderOut', + links: typing.Union['ObjectLinks', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLlmProviderOutDocument': + return super().__new__( + cls, + *_args, + data=data, + links=links, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_llm_provider_out import JsonApiLlmProviderOut +from gooddata_api_client.model.object_links import ObjectLinks 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 new file mode 100644 index 000000000..ba45baf9f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_list.py @@ -0,0 +1,290 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_aggregated_fact_out_list_meta import JsonApiAggregatedFactOutListMeta + from gooddata_api_client.model.json_api_llm_provider_out_with_links import JsonApiLlmProviderOutWithLinks + from gooddata_api_client.model.list_links import ListLinks + globals()['JsonApiAggregatedFactOutListMeta'] = JsonApiAggregatedFactOutListMeta + globals()['JsonApiLlmProviderOutWithLinks'] = JsonApiLlmProviderOutWithLinks + globals()['ListLinks'] = ListLinks + + +class JsonApiLlmProviderOutList(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('data',): { + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'data': ([JsonApiLlmProviderOutWithLinks],), # noqa: E501 + 'links': (ListLinks,), # noqa: E501 + 'meta': (JsonApiAggregatedFactOutListMeta,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiLlmProviderOutList - a model defined in OpenAPI + + Args: + data ([JsonApiLlmProviderOutWithLinks]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + links (ListLinks): [optional] # noqa: E501 + meta (JsonApiAggregatedFactOutListMeta): [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 + """JsonApiLlmProviderOutList - a model defined in OpenAPI + + Args: + data ([JsonApiLlmProviderOutWithLinks]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + links (ListLinks): [optional] # noqa: E501 + meta (JsonApiAggregatedFactOutListMeta): [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_llm_provider_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_list.pyi new file mode 100644 index 000000000..63999c4fb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_list.pyi @@ -0,0 +1,190 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLlmProviderOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiLlmProviderOutWithLinks']: + return JsonApiLlmProviderOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiLlmProviderOutWithLinks'], typing.List['JsonApiLlmProviderOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiLlmProviderOutWithLinks': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLlmProviderOutList': + return super().__new__( + cls, + *_args, + data=data, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_llm_provider_out_with_links import JsonApiLlmProviderOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_with_links.py new file mode 100644 index 000000000..04eaadf61 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_with_links.py @@ -0,0 +1,349 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_llm_provider_in_attributes import JsonApiLlmProviderInAttributes + from gooddata_api_client.model.json_api_llm_provider_out import JsonApiLlmProviderOut + from gooddata_api_client.model.object_links import ObjectLinks + from gooddata_api_client.model.object_links_container import ObjectLinksContainer + globals()['JsonApiLlmProviderInAttributes'] = JsonApiLlmProviderInAttributes + globals()['JsonApiLlmProviderOut'] = JsonApiLlmProviderOut + globals()['ObjectLinks'] = ObjectLinks + globals()['ObjectLinksContainer'] = ObjectLinksContainer + + +class JsonApiLlmProviderOutWithLinks(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',): { + 'LLMPROVIDER': "llmProvider", + }, + } + + 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': (JsonApiLlmProviderInAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # 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 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiLlmProviderOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiLlmProviderInAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "llmProvider", must be one of ["llmProvider", ] # 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,) + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "llmProvider") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_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 + """JsonApiLlmProviderOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiLlmProviderInAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "llmProvider", must be one of ["llmProvider", ] # 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,) + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "llmProvider") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_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': [ + JsonApiLlmProviderOut, + ObjectLinksContainer, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_with_links.pyi new file mode 100644 index 000000000..d64345ab1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLlmProviderOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiLlmProviderOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLlmProviderOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_llm_provider_out import JsonApiLlmProviderOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch.py new file mode 100644 index 000000000..d594e2772 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_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_llm_provider_patch_attributes import JsonApiLlmProviderPatchAttributes + globals()['JsonApiLlmProviderPatchAttributes'] = JsonApiLlmProviderPatchAttributes + + +class JsonApiLlmProviderPatch(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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',): { + 'LLMPROVIDER': "llmProvider", + }, + } + + 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': (JsonApiLlmProviderPatchAttributes,), # 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 + """JsonApiLlmProviderPatch - a model defined in OpenAPI + + Args: + attributes (JsonApiLlmProviderPatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "llmProvider", must be one of ["llmProvider", ] # 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', "llmProvider") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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 + """JsonApiLlmProviderPatch - a model defined in OpenAPI + + Args: + attributes (JsonApiLlmProviderPatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "llmProvider", must be one of ["llmProvider", ] # 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', "llmProvider") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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_llm_provider_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch.pyi new file mode 100644 index 000000000..41c9421e0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch.pyi @@ -0,0 +1,447 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLlmProviderPatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + LLM Provider configuration for connecting to LLM services. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class defaultModelId( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'defaultModelId': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class description( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'description': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class models( + schemas.ListBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneTupleMixin + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "id", + "family", + } + + class properties: + + + class family( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def OPENAI(cls): + return cls("OPENAI") + + @schemas.classproperty + def ANTHROPIC(cls): + return cls("ANTHROPIC") + + @schemas.classproperty + def META(cls): + return cls("META") + + @schemas.classproperty + def MISTRAL(cls): + return cls("MISTRAL") + + @schemas.classproperty + def AMAZON(cls): + return cls("AMAZON") + + @schemas.classproperty + def GOOGLE(cls): + return cls("GOOGLE") + + @schemas.classproperty + def COHERE(cls): + return cls("COHERE") + + + class id( + schemas.StrSchema + ): + pass + __annotations__ = { + "family": family, + "id": id, + } + + id: MetaOapg.properties.id + family: MetaOapg.properties.family + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["family"]) -> MetaOapg.properties.family: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["family", "id", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["family"]) -> MetaOapg.properties.family: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["family", "id", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + family: typing.Union[MetaOapg.properties.family, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + id=id, + family=family, + _configuration=_configuration, + **kwargs, + ) + + + def __new__( + cls, + *_args: typing.Union[list, tuple, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'models': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class name( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'name': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class providerConfig( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AwsBedrockProviderConfig, + AzureFoundryProviderConfig, + OpenAIProviderConfig, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'providerConfig': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "defaultModelId": defaultModelId, + "description": description, + "models": models, + "name": name, + "providerConfig": providerConfig, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["defaultModelId"]) -> MetaOapg.properties.defaultModelId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["models"]) -> MetaOapg.properties.models: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["providerConfig"]) -> MetaOapg.properties.providerConfig: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["defaultModelId", "description", "models", "name", "providerConfig", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["defaultModelId"]) -> typing.Union[MetaOapg.properties.defaultModelId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["models"]) -> typing.Union[MetaOapg.properties.models, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["providerConfig"]) -> typing.Union[MetaOapg.properties.providerConfig, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["defaultModelId", "description", "models", "name", "providerConfig", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + defaultModelId: typing.Union[MetaOapg.properties.defaultModelId, None, str, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, None, str, schemas.Unset] = schemas.unset, + models: typing.Union[MetaOapg.properties.models, list, tuple, None, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, None, str, schemas.Unset] = schemas.unset, + providerConfig: typing.Union[MetaOapg.properties.providerConfig, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + defaultModelId=defaultModelId, + description=description, + models=models, + name=name, + providerConfig=providerConfig, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def LLM_PROVIDER(cls): + return cls("llmProvider") + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLlmProviderPatch': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aws_bedrock_provider_config import AwsBedrockProviderConfig +from gooddata_api_client.model.azure_foundry_provider_config import AzureFoundryProviderConfig +from gooddata_api_client.model.open_ai_provider_config import OpenAIProviderConfig diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch_attributes.py new file mode 100644 index 000000000..64f5ee3fc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch_attributes.py @@ -0,0 +1,297 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_llm_provider_in_attributes_models_inner import JsonApiLlmProviderInAttributesModelsInner + from gooddata_api_client.model.json_api_llm_provider_in_attributes_provider_config import JsonApiLlmProviderInAttributesProviderConfig + globals()['JsonApiLlmProviderInAttributesModelsInner'] = JsonApiLlmProviderInAttributesModelsInner + globals()['JsonApiLlmProviderInAttributesProviderConfig'] = JsonApiLlmProviderInAttributesProviderConfig + + +class JsonApiLlmProviderPatchAttributes(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 = { + ('default_model_id',): { + 'max_length': 255, + }, + ('description',): { + 'max_length': 10000, + }, + ('name',): { + 'max_length': 255, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'default_model_id': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'models': ([JsonApiLlmProviderInAttributesModelsInner], none_type,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + 'provider_config': (JsonApiLlmProviderInAttributesProviderConfig,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'default_model_id': 'defaultModelId', # noqa: E501 + 'description': 'description', # noqa: E501 + 'models': 'models', # noqa: E501 + 'name': 'name', # noqa: E501 + 'provider_config': 'providerConfig', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiLlmProviderPatchAttributes - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + default_model_id (str, none_type): ID of the default model to use from the models list.. [optional] # noqa: E501 + description (str, none_type): Description of the LLM Provider.. [optional] # noqa: E501 + models ([JsonApiLlmProviderInAttributesModelsInner], none_type): List of LLM models available for this provider.. [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 + provider_config (JsonApiLlmProviderInAttributesProviderConfig): [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 + """JsonApiLlmProviderPatchAttributes - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + default_model_id (str, none_type): ID of the default model to use from the models list.. [optional] # noqa: E501 + description (str, none_type): Description of the LLM Provider.. [optional] # noqa: E501 + models ([JsonApiLlmProviderInAttributesModelsInner], none_type): List of LLM models available for this provider.. [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 + provider_config (JsonApiLlmProviderInAttributesProviderConfig): [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_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch_document.py new file mode 100644 index 000000000..8664449b7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_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_llm_provider_patch import JsonApiLlmProviderPatch + globals()['JsonApiLlmProviderPatch'] = JsonApiLlmProviderPatch + + +class JsonApiLlmProviderPatchDocument(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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': (JsonApiLlmProviderPatch,), # 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 + """JsonApiLlmProviderPatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiLlmProviderPatch): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiLlmProviderPatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiLlmProviderPatch): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_llm_provider_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch_document.pyi new file mode 100644 index 000000000..df78098bd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiLlmProviderPatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiLlmProviderPatch']: + return JsonApiLlmProviderPatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiLlmProviderPatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLlmProviderPatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiLlmProviderPatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiLlmProviderPatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiLlmProviderPatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_llm_provider_patch import JsonApiLlmProviderPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_in.pyi new file mode 100644 index 000000000..97f93f5f7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_in.pyi @@ -0,0 +1,322 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiMemoryItemIn( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of memoryItem entity. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "instruction", + "strategy", + } + + class properties: + areRelationsValid = schemas.BoolSchema + + + class description( + schemas.StrSchema + ): + pass + + + class instruction( + schemas.StrSchema + ): + pass + isDisabled = schemas.BoolSchema + + + class keywords( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'keywords': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class strategy( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ALWAYS(cls): + return cls("ALWAYS") + + @schemas.classproperty + def AUTO(cls): + return cls("AUTO") + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "areRelationsValid": areRelationsValid, + "description": description, + "instruction": instruction, + "isDisabled": isDisabled, + "keywords": keywords, + "strategy": strategy, + "tags": tags, + "title": title, + } + + instruction: MetaOapg.properties.instruction + strategy: MetaOapg.properties.strategy + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["instruction"]) -> MetaOapg.properties.instruction: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isDisabled"]) -> MetaOapg.properties.isDisabled: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["keywords"]) -> MetaOapg.properties.keywords: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["strategy"]) -> MetaOapg.properties.strategy: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "instruction", "isDisabled", "keywords", "strategy", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["instruction"]) -> MetaOapg.properties.instruction: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isDisabled"]) -> typing.Union[MetaOapg.properties.isDisabled, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["keywords"]) -> typing.Union[MetaOapg.properties.keywords, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["strategy"]) -> MetaOapg.properties.strategy: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "instruction", "isDisabled", "keywords", "strategy", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + instruction: typing.Union[MetaOapg.properties.instruction, str, ], + strategy: typing.Union[MetaOapg.properties.strategy, str, ], + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + isDisabled: typing.Union[MetaOapg.properties.isDisabled, bool, schemas.Unset] = schemas.unset, + keywords: typing.Union[MetaOapg.properties.keywords, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + instruction=instruction, + strategy=strategy, + areRelationsValid=areRelationsValid, + description=description, + isDisabled=isDisabled, + keywords=keywords, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MEMORY_ITEM(cls): + return cls("memoryItem") + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiMemoryItemIn': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_in_document.pyi new file mode 100644 index 000000000..418f29a7b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_in_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiMemoryItemInDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiMemoryItemIn']: + return JsonApiMemoryItemIn + __annotations__ = { + "data": data, + } + + data: 'JsonApiMemoryItemIn' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMemoryItemIn': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMemoryItemIn': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiMemoryItemIn', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiMemoryItemInDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_memory_item_in import JsonApiMemoryItemIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out.pyi new file mode 100644 index 000000000..ddad89e63 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out.pyi @@ -0,0 +1,713 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiMemoryItemOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of memoryItem entity. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "instruction", + "strategy", + } + + class properties: + areRelationsValid = schemas.BoolSchema + + + class createdAt( + schemas.DateTimeBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + format = 'date-time' + + + def __new__( + cls, + *_args: typing.Union[None, str, datetime, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'createdAt': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class description( + schemas.StrSchema + ): + pass + + + class instruction( + schemas.StrSchema + ): + pass + isDisabled = schemas.BoolSchema + + + class keywords( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'keywords': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class modifiedAt( + schemas.DateTimeBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + format = 'date-time' + + + def __new__( + cls, + *_args: typing.Union[None, str, datetime, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'modifiedAt': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class strategy( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ALWAYS(cls): + return cls("ALWAYS") + + @schemas.classproperty + def AUTO(cls): + return cls("AUTO") + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "areRelationsValid": areRelationsValid, + "createdAt": createdAt, + "description": description, + "instruction": instruction, + "isDisabled": isDisabled, + "keywords": keywords, + "modifiedAt": modifiedAt, + "strategy": strategy, + "tags": tags, + "title": title, + } + + instruction: MetaOapg.properties.instruction + strategy: MetaOapg.properties.strategy + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdAt"]) -> MetaOapg.properties.createdAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["instruction"]) -> MetaOapg.properties.instruction: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isDisabled"]) -> MetaOapg.properties.isDisabled: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["keywords"]) -> MetaOapg.properties.keywords: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedAt"]) -> MetaOapg.properties.modifiedAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["strategy"]) -> MetaOapg.properties.strategy: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "createdAt", "description", "instruction", "isDisabled", "keywords", "modifiedAt", "strategy", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdAt"]) -> typing.Union[MetaOapg.properties.createdAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["instruction"]) -> MetaOapg.properties.instruction: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isDisabled"]) -> typing.Union[MetaOapg.properties.isDisabled, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["keywords"]) -> typing.Union[MetaOapg.properties.keywords, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedAt"]) -> typing.Union[MetaOapg.properties.modifiedAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["strategy"]) -> MetaOapg.properties.strategy: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "createdAt", "description", "instruction", "isDisabled", "keywords", "modifiedAt", "strategy", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + instruction: typing.Union[MetaOapg.properties.instruction, str, ], + strategy: typing.Union[MetaOapg.properties.strategy, str, ], + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + createdAt: typing.Union[MetaOapg.properties.createdAt, None, str, datetime, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + isDisabled: typing.Union[MetaOapg.properties.isDisabled, bool, schemas.Unset] = schemas.unset, + keywords: typing.Union[MetaOapg.properties.keywords, list, tuple, schemas.Unset] = schemas.unset, + modifiedAt: typing.Union[MetaOapg.properties.modifiedAt, None, str, datetime, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + instruction=instruction, + strategy=strategy, + areRelationsValid=areRelationsValid, + createdAt=createdAt, + description=description, + isDisabled=isDisabled, + keywords=keywords, + modifiedAt=modifiedAt, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MEMORY_ITEM(cls): + return cls("memoryItem") + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class origin( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "originType", + "originId", + } + + class properties: + originId = schemas.StrSchema + + + class originType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") + + @schemas.classproperty + def PARENT(cls): + return cls("PARENT") + __annotations__ = { + "originId": originId, + "originType": originType, + } + + originType: MetaOapg.properties.originType + originId: MetaOapg.properties.originId + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["originId"]) -> MetaOapg.properties.originId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["originType"]) -> MetaOapg.properties.originType: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["originId", "originType", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + originType: typing.Union[MetaOapg.properties.originType, str, ], + originId: typing.Union[MetaOapg.properties.originId, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'origin': + return super().__new__( + cls, + *_args, + originType=originType, + originId=originId, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "origin": origin, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["origin"]) -> MetaOapg.properties.origin: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["origin"]) -> typing.Union[MetaOapg.properties.origin, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["origin", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + origin: typing.Union[MetaOapg.properties.origin, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + origin=origin, + _configuration=_configuration, + **kwargs, + ) + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class createdBy( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserIdentifierToOneLinkage']: + return JsonApiUserIdentifierToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserIdentifierToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserIdentifierToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'createdBy': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class modifiedBy( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserIdentifierToOneLinkage']: + return JsonApiUserIdentifierToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserIdentifierToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserIdentifierToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'modifiedBy': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "createdBy": createdBy, + "modifiedBy": modifiedBy, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdBy"]) -> MetaOapg.properties.createdBy: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedBy"]) -> MetaOapg.properties.modifiedBy: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["createdBy", "modifiedBy", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdBy"]) -> typing.Union[MetaOapg.properties.createdBy, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedBy"]) -> typing.Union[MetaOapg.properties.modifiedBy, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["createdBy", "modifiedBy", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + createdBy: typing.Union[MetaOapg.properties.createdBy, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + modifiedBy: typing.Union[MetaOapg.properties.modifiedBy, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + createdBy=createdBy, + modifiedBy=modifiedBy, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + "meta": meta, + "relationships": relationships, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "meta", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", "meta", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiMemoryItemOut': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + meta=meta, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_user_identifier_to_one_linkage import JsonApiUserIdentifierToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_document.pyi new file mode 100644 index 000000000..39cd54241 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_document.pyi @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiMemoryItemOutDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiMemoryItemOut']: + return JsonApiMemoryItemOut + + + class included( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiUserIdentifierOutWithLinks']: + return JsonApiUserIdentifierOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiUserIdentifierOutWithLinks'], typing.List['JsonApiUserIdentifierOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'included': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiUserIdentifierOutWithLinks': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ObjectLinks']: + return ObjectLinks + __annotations__ = { + "data": data, + "included": included, + "links": links, + } + + data: 'JsonApiMemoryItemOut' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMemoryItemOut': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMemoryItemOut': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiMemoryItemOut', + included: typing.Union[MetaOapg.properties.included, list, tuple, schemas.Unset] = schemas.unset, + links: typing.Union['ObjectLinks', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiMemoryItemOutDocument': + return super().__new__( + cls, + *_args, + data=data, + included=included, + links=links, + _configuration=_configuration, + **kwargs, + ) + +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 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_list.pyi new file mode 100644 index 000000000..92abf0c6b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_list.pyi @@ -0,0 +1,226 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiMemoryItemOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiMemoryItemOutWithLinks']: + return JsonApiMemoryItemOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiMemoryItemOutWithLinks'], typing.List['JsonApiMemoryItemOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiMemoryItemOutWithLinks': + return super().__getitem__(i) + + + class included( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiUserIdentifierOutWithLinks']: + return JsonApiUserIdentifierOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiUserIdentifierOutWithLinks'], typing.List['JsonApiUserIdentifierOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'included': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiUserIdentifierOutWithLinks': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "included": included, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + included: typing.Union[MetaOapg.properties.included, list, tuple, schemas.Unset] = schemas.unset, + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiMemoryItemOutList': + return super().__new__( + cls, + *_args, + data=data, + included=included, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_memory_item_out_with_links import JsonApiMemoryItemOutWithLinks +from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_with_links.pyi new file mode 100644 index 000000000..7e406de99 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiMemoryItemOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiMemoryItemOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiMemoryItemOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_memory_item_out import JsonApiMemoryItemOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_patch.pyi new file mode 100644 index 000000000..479fe2850 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_patch.pyi @@ -0,0 +1,315 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiMemoryItemPatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching memoryItem entity. + """ + + + class MetaOapg: + required = { + "attributes", + "id", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + areRelationsValid = schemas.BoolSchema + + + class description( + schemas.StrSchema + ): + pass + + + class instruction( + schemas.StrSchema + ): + pass + isDisabled = schemas.BoolSchema + + + class keywords( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'keywords': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class strategy( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ALWAYS(cls): + return cls("ALWAYS") + + @schemas.classproperty + def AUTO(cls): + return cls("AUTO") + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "areRelationsValid": areRelationsValid, + "description": description, + "instruction": instruction, + "isDisabled": isDisabled, + "keywords": keywords, + "strategy": strategy, + "tags": tags, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["instruction"]) -> MetaOapg.properties.instruction: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isDisabled"]) -> MetaOapg.properties.isDisabled: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["keywords"]) -> MetaOapg.properties.keywords: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["strategy"]) -> MetaOapg.properties.strategy: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "instruction", "isDisabled", "keywords", "strategy", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["instruction"]) -> typing.Union[MetaOapg.properties.instruction, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isDisabled"]) -> typing.Union[MetaOapg.properties.isDisabled, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["keywords"]) -> typing.Union[MetaOapg.properties.keywords, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["strategy"]) -> typing.Union[MetaOapg.properties.strategy, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "instruction", "isDisabled", "keywords", "strategy", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + instruction: typing.Union[MetaOapg.properties.instruction, str, schemas.Unset] = schemas.unset, + isDisabled: typing.Union[MetaOapg.properties.isDisabled, bool, schemas.Unset] = schemas.unset, + keywords: typing.Union[MetaOapg.properties.keywords, list, tuple, schemas.Unset] = schemas.unset, + strategy: typing.Union[MetaOapg.properties.strategy, str, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + areRelationsValid=areRelationsValid, + description=description, + instruction=instruction, + isDisabled=isDisabled, + keywords=keywords, + strategy=strategy, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MEMORY_ITEM(cls): + return cls("memoryItem") + __annotations__ = { + "attributes": attributes, + "id": id, + "type": type, + } + + attributes: MetaOapg.properties.attributes + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiMemoryItemPatch': + return super().__new__( + cls, + *_args, + attributes=attributes, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_patch_document.pyi new file mode 100644 index 000000000..bc9e0899f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiMemoryItemPatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiMemoryItemPatch']: + return JsonApiMemoryItemPatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiMemoryItemPatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMemoryItemPatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMemoryItemPatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiMemoryItemPatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiMemoryItemPatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_memory_item_patch import JsonApiMemoryItemPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_post_optional_id.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_post_optional_id.pyi new file mode 100644 index 000000000..dc50c94f5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_post_optional_id.pyi @@ -0,0 +1,320 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiMemoryItemPostOptionalId( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of memoryItem entity. + """ + + + class MetaOapg: + required = { + "attributes", + "type", + } + + class properties: + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "instruction", + "strategy", + } + + class properties: + areRelationsValid = schemas.BoolSchema + + + class description( + schemas.StrSchema + ): + pass + + + class instruction( + schemas.StrSchema + ): + pass + isDisabled = schemas.BoolSchema + + + class keywords( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'keywords': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class strategy( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ALWAYS(cls): + return cls("ALWAYS") + + @schemas.classproperty + def AUTO(cls): + return cls("AUTO") + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "areRelationsValid": areRelationsValid, + "description": description, + "instruction": instruction, + "isDisabled": isDisabled, + "keywords": keywords, + "strategy": strategy, + "tags": tags, + "title": title, + } + + instruction: MetaOapg.properties.instruction + strategy: MetaOapg.properties.strategy + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["instruction"]) -> MetaOapg.properties.instruction: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isDisabled"]) -> MetaOapg.properties.isDisabled: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["keywords"]) -> MetaOapg.properties.keywords: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["strategy"]) -> MetaOapg.properties.strategy: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "instruction", "isDisabled", "keywords", "strategy", "tags", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["instruction"]) -> MetaOapg.properties.instruction: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isDisabled"]) -> typing.Union[MetaOapg.properties.isDisabled, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["keywords"]) -> typing.Union[MetaOapg.properties.keywords, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["strategy"]) -> MetaOapg.properties.strategy: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["areRelationsValid", "description", "instruction", "isDisabled", "keywords", "strategy", "tags", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + instruction: typing.Union[MetaOapg.properties.instruction, str, ], + strategy: typing.Union[MetaOapg.properties.strategy, str, ], + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + isDisabled: typing.Union[MetaOapg.properties.isDisabled, bool, schemas.Unset] = schemas.unset, + keywords: typing.Union[MetaOapg.properties.keywords, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + instruction=instruction, + strategy=strategy, + areRelationsValid=areRelationsValid, + description=description, + isDisabled=isDisabled, + keywords=keywords, + tags=tags, + title=title, + _configuration=_configuration, + **kwargs, + ) + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MEMORY_ITEM(cls): + return cls("memoryItem") + + + class id( + schemas.StrSchema + ): + pass + __annotations__ = { + "attributes": attributes, + "type": type, + "id": id, + } + + attributes: MetaOapg.properties.attributes + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "type", "id", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> typing.Union[MetaOapg.properties.id, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "type", "id", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + id: typing.Union[MetaOapg.properties.id, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiMemoryItemPostOptionalId': + return super().__new__( + cls, + *_args, + attributes=attributes, + type=type, + id=id, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_post_optional_id_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_post_optional_id_document.pyi new file mode 100644 index 000000000..db828f330 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_post_optional_id_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiMemoryItemPostOptionalIdDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiMemoryItemPostOptionalId']: + return JsonApiMemoryItemPostOptionalId + __annotations__ = { + "data": data, + } + + data: 'JsonApiMemoryItemPostOptionalId' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMemoryItemPostOptionalId': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiMemoryItemPostOptionalId': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiMemoryItemPostOptionalId', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiMemoryItemPostOptionalIdDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_memory_item_post_optional_id import JsonApiMemoryItemPostOptionalId 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 83d497548..50a691dde 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 @@ -60,9 +60,17 @@ class JsonApiMetricOutAttributes(ModelNormal): """ allowed_values = { + ('certification',): { + 'CERTIFIED': "CERTIFIED", + }, } validations = { + ('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 @@ -106,6 +114,9 @@ def openapi_types(): return { 'content': (JsonApiMetricInAttributesContent,), # 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 'description': (str,), # noqa: E501 'is_hidden': (bool,), # noqa: E501 @@ -123,6 +134,9 @@ def discriminator(): attribute_map = { '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 'description': 'description', # noqa: E501 'is_hidden': 'isHidden', # noqa: E501 @@ -177,6 +191,9 @@ 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 + 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 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 @@ -274,6 +291,9 @@ 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 + 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 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_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_relationships.py index 5c3ebc5c8..8dd8af9f1 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_metric_out_relationships.py @@ -31,13 +31,13 @@ def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_certified_by import JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy 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_dataset_out_relationships_facts import JsonApiDatasetOutRelationshipsFacts - globals()['JsonApiAnalyticalDashboardOutRelationshipsCreatedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy + globals()['JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy globals()['JsonApiAnalyticalDashboardOutRelationshipsDatasets'] = JsonApiAnalyticalDashboardOutRelationshipsDatasets globals()['JsonApiAnalyticalDashboardOutRelationshipsLabels'] = JsonApiAnalyticalDashboardOutRelationshipsLabels globals()['JsonApiAnalyticalDashboardOutRelationshipsMetrics'] = JsonApiAnalyticalDashboardOutRelationshipsMetrics @@ -99,12 +99,13 @@ def openapi_types(): lazy_import() return { 'attributes': (JsonApiAttributeHierarchyOutRelationshipsAttributes,), # noqa: E501 - 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 + 'certified_by': (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy,), # noqa: E501 + 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy,), # noqa: E501 'datasets': (JsonApiAnalyticalDashboardOutRelationshipsDatasets,), # noqa: E501 'facts': (JsonApiDatasetOutRelationshipsFacts,), # noqa: E501 'labels': (JsonApiAnalyticalDashboardOutRelationshipsLabels,), # noqa: E501 'metrics': (JsonApiAnalyticalDashboardOutRelationshipsMetrics,), # noqa: E501 - 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 + 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy,), # noqa: E501 } @cached_property @@ -114,6 +115,7 @@ def discriminator(): attribute_map = { 'attributes': 'attributes', # noqa: E501 + 'certified_by': 'certifiedBy', # noqa: E501 'created_by': 'createdBy', # noqa: E501 'datasets': 'datasets', # noqa: E501 'facts': 'facts', # noqa: E501 @@ -164,12 +166,13 @@ 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 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + certified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 + created_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 facts (JsonApiDatasetOutRelationshipsFacts): [optional] # noqa: E501 labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + modified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -256,12 +259,13 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + certified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 + created_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 facts (JsonApiDatasetOutRelationshipsFacts): [optional] # noqa: E501 labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + modified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_to_one_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_metric_to_one_linkage.pyi new file mode 100644 index 000000000..7e6af005d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_to_one_linkage.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiMetricToOneLinkage( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + JsonApiMetricLinkage, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiMetricToOneLinkage': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_metric_linkage import JsonApiMetricLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out.pyi new file mode 100644 index 000000000..4e7452fd9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out.pyi @@ -0,0 +1,283 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiNotificationChannelIdentifierOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of notificationChannelIdentifier entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NOTIFICATION_CHANNEL_IDENTIFIER(cls): + return cls("notificationChannelIdentifier") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class allowedRecipients( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def CREATOR(cls): + return cls("CREATOR") + + @schemas.classproperty + def INTERNAL(cls): + return cls("INTERNAL") + + @schemas.classproperty + def EXTERNAL(cls): + return cls("EXTERNAL") + + + class description( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'description': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class destinationType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def WEBHOOK(cls): + return cls("WEBHOOK") + + @schemas.classproperty + def SMTP(cls): + return cls("SMTP") + + @schemas.classproperty + def DEFAULT_SMTP(cls): + return cls("DEFAULT_SMTP") + + @schemas.classproperty + def IN_PLATFORM(cls): + return cls("IN_PLATFORM") + + + class name( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'name': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + __annotations__ = { + "allowedRecipients": allowedRecipients, + "description": description, + "destinationType": destinationType, + "name": name, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["allowedRecipients"]) -> MetaOapg.properties.allowedRecipients: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["destinationType"]) -> MetaOapg.properties.destinationType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["allowedRecipients", "description", "destinationType", "name", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["allowedRecipients"]) -> typing.Union[MetaOapg.properties.allowedRecipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["destinationType"]) -> typing.Union[MetaOapg.properties.destinationType, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["allowedRecipients", "description", "destinationType", "name", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + allowedRecipients: typing.Union[MetaOapg.properties.allowedRecipients, str, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, None, str, schemas.Unset] = schemas.unset, + destinationType: typing.Union[MetaOapg.properties.destinationType, str, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, None, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + allowedRecipients=allowedRecipients, + description=description, + destinationType=destinationType, + name=name, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiNotificationChannelIdentifierOut': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_document.pyi new file mode 100644 index 000000000..0a9fd51d8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_document.pyi @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiNotificationChannelIdentifierOutDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiNotificationChannelIdentifierOut']: + return JsonApiNotificationChannelIdentifierOut + + @staticmethod + def links() -> typing.Type['ObjectLinks']: + return ObjectLinks + __annotations__ = { + "data": data, + "links": links, + } + + data: 'JsonApiNotificationChannelIdentifierOut' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelIdentifierOut': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelIdentifierOut': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiNotificationChannelIdentifierOut', + links: typing.Union['ObjectLinks', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiNotificationChannelIdentifierOutDocument': + return super().__new__( + cls, + *_args, + data=data, + links=links, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_notification_channel_identifier_out import JsonApiNotificationChannelIdentifierOut +from gooddata_api_client.model.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_list.pyi new file mode 100644 index 000000000..1325854bb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_list.pyi @@ -0,0 +1,190 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiNotificationChannelIdentifierOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiNotificationChannelIdentifierOutWithLinks']: + return JsonApiNotificationChannelIdentifierOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiNotificationChannelIdentifierOutWithLinks'], typing.List['JsonApiNotificationChannelIdentifierOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiNotificationChannelIdentifierOutWithLinks': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiNotificationChannelIdentifierOutList': + return super().__new__( + cls, + *_args, + data=data, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_notification_channel_identifier_out_with_links import JsonApiNotificationChannelIdentifierOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_with_links.pyi new file mode 100644 index 000000000..eb7038c0e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiNotificationChannelIdentifierOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiNotificationChannelIdentifierOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiNotificationChannelIdentifierOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_notification_channel_identifier_out import JsonApiNotificationChannelIdentifierOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in.pyi new file mode 100644 index 000000000..55c301a7f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in.pyi @@ -0,0 +1,385 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiNotificationChannelIn( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of notificationChannel entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class allowedRecipients( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def CREATOR(cls): + return cls("CREATOR") + + @schemas.classproperty + def INTERNAL(cls): + return cls("INTERNAL") + + @schemas.classproperty + def EXTERNAL(cls): + return cls("EXTERNAL") + + + class customDashboardUrl( + schemas.StrSchema + ): + pass + + + class dashboardLinkVisibility( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def HIDDEN(cls): + return cls("HIDDEN") + + @schemas.classproperty + def INTERNAL_ONLY(cls): + return cls("INTERNAL_ONLY") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + + class description( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'description': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class destination( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + DefaultSmtp, + InPlatform, + Smtp, + Webhook, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'destination': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class inPlatformNotification( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DISABLED(cls): + return cls("DISABLED") + + @schemas.classproperty + def ENABLED(cls): + return cls("ENABLED") + + + class name( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'name': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class notificationSource( + schemas.StrSchema + ): + pass + __annotations__ = { + "allowedRecipients": allowedRecipients, + "customDashboardUrl": customDashboardUrl, + "dashboardLinkVisibility": dashboardLinkVisibility, + "description": description, + "destination": destination, + "inPlatformNotification": inPlatformNotification, + "name": name, + "notificationSource": notificationSource, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["allowedRecipients"]) -> MetaOapg.properties.allowedRecipients: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["customDashboardUrl"]) -> MetaOapg.properties.customDashboardUrl: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardLinkVisibility"]) -> MetaOapg.properties.dashboardLinkVisibility: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["destination"]) -> MetaOapg.properties.destination: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["inPlatformNotification"]) -> MetaOapg.properties.inPlatformNotification: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["notificationSource"]) -> MetaOapg.properties.notificationSource: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["allowedRecipients", "customDashboardUrl", "dashboardLinkVisibility", "description", "destination", "inPlatformNotification", "name", "notificationSource", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["allowedRecipients"]) -> typing.Union[MetaOapg.properties.allowedRecipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["customDashboardUrl"]) -> typing.Union[MetaOapg.properties.customDashboardUrl, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardLinkVisibility"]) -> typing.Union[MetaOapg.properties.dashboardLinkVisibility, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["destination"]) -> typing.Union[MetaOapg.properties.destination, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["inPlatformNotification"]) -> typing.Union[MetaOapg.properties.inPlatformNotification, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["notificationSource"]) -> typing.Union[MetaOapg.properties.notificationSource, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["allowedRecipients", "customDashboardUrl", "dashboardLinkVisibility", "description", "destination", "inPlatformNotification", "name", "notificationSource", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + allowedRecipients: typing.Union[MetaOapg.properties.allowedRecipients, str, schemas.Unset] = schemas.unset, + customDashboardUrl: typing.Union[MetaOapg.properties.customDashboardUrl, str, schemas.Unset] = schemas.unset, + dashboardLinkVisibility: typing.Union[MetaOapg.properties.dashboardLinkVisibility, str, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, None, str, schemas.Unset] = schemas.unset, + destination: typing.Union[MetaOapg.properties.destination, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + inPlatformNotification: typing.Union[MetaOapg.properties.inPlatformNotification, str, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, None, str, schemas.Unset] = schemas.unset, + notificationSource: typing.Union[MetaOapg.properties.notificationSource, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + allowedRecipients=allowedRecipients, + customDashboardUrl=customDashboardUrl, + dashboardLinkVisibility=dashboardLinkVisibility, + description=description, + destination=destination, + inPlatformNotification=inPlatformNotification, + name=name, + notificationSource=notificationSource, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiNotificationChannelIn': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.default_smtp import DefaultSmtp +from gooddata_api_client.model.in_platform import InPlatform +from gooddata_api_client.model.smtp import Smtp +from gooddata_api_client.model.webhook import Webhook diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in_attributes_destination.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in_attributes_destination.py index 7fae26b1e..7bc9e12b4 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in_attributes_destination.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in_attributes_destination.py @@ -78,6 +78,10 @@ class JsonApiNotificationChannelInAttributesDestination(ModelComposed): } validations = { + ('has_secret_key',): { + }, + ('has_token',): { + }, ('secret_key',): { 'max_length': 10000, }, diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in_document.pyi new file mode 100644 index 000000000..661f39fa0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_in_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiNotificationChannelInDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiNotificationChannelIn']: + return JsonApiNotificationChannelIn + __annotations__ = { + "data": data, + } + + data: 'JsonApiNotificationChannelIn' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelIn': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelIn': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiNotificationChannelIn', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiNotificationChannelInDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_notification_channel_in import JsonApiNotificationChannelIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_linkage.pyi new file mode 100644 index 000000000..a43bd8255 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_linkage.pyi @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiNotificationChannelLinkage( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + The \"type\" and \"id\" to non-empty members. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiNotificationChannelLinkage': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out.pyi new file mode 100644 index 000000000..e24f54026 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out.pyi @@ -0,0 +1,440 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiNotificationChannelOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of notificationChannel entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class allowedRecipients( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def CREATOR(cls): + return cls("CREATOR") + + @schemas.classproperty + def INTERNAL(cls): + return cls("INTERNAL") + + @schemas.classproperty + def EXTERNAL(cls): + return cls("EXTERNAL") + + + class customDashboardUrl( + schemas.StrSchema + ): + pass + + + class dashboardLinkVisibility( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def HIDDEN(cls): + return cls("HIDDEN") + + @schemas.classproperty + def INTERNAL_ONLY(cls): + return cls("INTERNAL_ONLY") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + + class description( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'description': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class destination( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + DefaultSmtp, + InPlatform, + Smtp, + Webhook, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'destination': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class destinationType( + schemas.EnumBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + enum_value_to_name = { + "WEBHOOK": "WEBHOOK", + "SMTP": "SMTP", + "DEFAULT_SMTP": "DEFAULT_SMTP", + "IN_PLATFORM": "IN_PLATFORM", + } + + @schemas.classproperty + def WEBHOOK(cls): + return cls("WEBHOOK") + + @schemas.classproperty + def SMTP(cls): + return cls("SMTP") + + @schemas.classproperty + def DEFAULT_SMTP(cls): + return cls("DEFAULT_SMTP") + + @schemas.classproperty + def IN_PLATFORM(cls): + return cls("IN_PLATFORM") + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'destinationType': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class inPlatformNotification( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DISABLED(cls): + return cls("DISABLED") + + @schemas.classproperty + def ENABLED(cls): + return cls("ENABLED") + + + class name( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'name': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class notificationSource( + schemas.StrSchema + ): + pass + __annotations__ = { + "allowedRecipients": allowedRecipients, + "customDashboardUrl": customDashboardUrl, + "dashboardLinkVisibility": dashboardLinkVisibility, + "description": description, + "destination": destination, + "destinationType": destinationType, + "inPlatformNotification": inPlatformNotification, + "name": name, + "notificationSource": notificationSource, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["allowedRecipients"]) -> MetaOapg.properties.allowedRecipients: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["customDashboardUrl"]) -> MetaOapg.properties.customDashboardUrl: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardLinkVisibility"]) -> MetaOapg.properties.dashboardLinkVisibility: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["destination"]) -> MetaOapg.properties.destination: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["destinationType"]) -> MetaOapg.properties.destinationType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["inPlatformNotification"]) -> MetaOapg.properties.inPlatformNotification: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["notificationSource"]) -> MetaOapg.properties.notificationSource: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["allowedRecipients", "customDashboardUrl", "dashboardLinkVisibility", "description", "destination", "destinationType", "inPlatformNotification", "name", "notificationSource", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["allowedRecipients"]) -> typing.Union[MetaOapg.properties.allowedRecipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["customDashboardUrl"]) -> typing.Union[MetaOapg.properties.customDashboardUrl, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardLinkVisibility"]) -> typing.Union[MetaOapg.properties.dashboardLinkVisibility, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["destination"]) -> typing.Union[MetaOapg.properties.destination, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["destinationType"]) -> typing.Union[MetaOapg.properties.destinationType, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["inPlatformNotification"]) -> typing.Union[MetaOapg.properties.inPlatformNotification, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["notificationSource"]) -> typing.Union[MetaOapg.properties.notificationSource, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["allowedRecipients", "customDashboardUrl", "dashboardLinkVisibility", "description", "destination", "destinationType", "inPlatformNotification", "name", "notificationSource", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + allowedRecipients: typing.Union[MetaOapg.properties.allowedRecipients, str, schemas.Unset] = schemas.unset, + customDashboardUrl: typing.Union[MetaOapg.properties.customDashboardUrl, str, schemas.Unset] = schemas.unset, + dashboardLinkVisibility: typing.Union[MetaOapg.properties.dashboardLinkVisibility, str, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, None, str, schemas.Unset] = schemas.unset, + destination: typing.Union[MetaOapg.properties.destination, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + destinationType: typing.Union[MetaOapg.properties.destinationType, None, str, schemas.Unset] = schemas.unset, + inPlatformNotification: typing.Union[MetaOapg.properties.inPlatformNotification, str, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, None, str, schemas.Unset] = schemas.unset, + notificationSource: typing.Union[MetaOapg.properties.notificationSource, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + allowedRecipients=allowedRecipients, + customDashboardUrl=customDashboardUrl, + dashboardLinkVisibility=dashboardLinkVisibility, + description=description, + destination=destination, + destinationType=destinationType, + inPlatformNotification=inPlatformNotification, + name=name, + notificationSource=notificationSource, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiNotificationChannelOut': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.default_smtp import DefaultSmtp +from gooddata_api_client.model.in_platform import InPlatform +from gooddata_api_client.model.smtp import Smtp +from gooddata_api_client.model.webhook import Webhook diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_document.pyi new file mode 100644 index 000000000..9f7873798 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_document.pyi @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiNotificationChannelOutDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiNotificationChannelOut']: + return JsonApiNotificationChannelOut + + @staticmethod + def links() -> typing.Type['ObjectLinks']: + return ObjectLinks + __annotations__ = { + "data": data, + "links": links, + } + + data: 'JsonApiNotificationChannelOut' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelOut': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelOut': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiNotificationChannelOut', + links: typing.Union['ObjectLinks', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiNotificationChannelOutDocument': + return super().__new__( + cls, + *_args, + data=data, + links=links, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_notification_channel_out import JsonApiNotificationChannelOut +from gooddata_api_client.model.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_list.pyi new file mode 100644 index 000000000..2f18fb014 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_list.pyi @@ -0,0 +1,190 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiNotificationChannelOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiNotificationChannelOutWithLinks']: + return JsonApiNotificationChannelOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiNotificationChannelOutWithLinks'], typing.List['JsonApiNotificationChannelOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiNotificationChannelOutWithLinks': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiNotificationChannelOutList': + return super().__new__( + cls, + *_args, + data=data, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_notification_channel_out_with_links import JsonApiNotificationChannelOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_with_links.pyi new file mode 100644 index 000000000..3ae7eb545 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiNotificationChannelOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiNotificationChannelOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiNotificationChannelOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_notification_channel_out import JsonApiNotificationChannelOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_patch.pyi new file mode 100644 index 000000000..482d0f786 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_patch.pyi @@ -0,0 +1,385 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiNotificationChannelPatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching notificationChannel entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class allowedRecipients( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def CREATOR(cls): + return cls("CREATOR") + + @schemas.classproperty + def INTERNAL(cls): + return cls("INTERNAL") + + @schemas.classproperty + def EXTERNAL(cls): + return cls("EXTERNAL") + + + class customDashboardUrl( + schemas.StrSchema + ): + pass + + + class dashboardLinkVisibility( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def HIDDEN(cls): + return cls("HIDDEN") + + @schemas.classproperty + def INTERNAL_ONLY(cls): + return cls("INTERNAL_ONLY") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + + class description( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'description': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class destination( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + DefaultSmtp, + InPlatform, + Smtp, + Webhook, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'destination': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class inPlatformNotification( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DISABLED(cls): + return cls("DISABLED") + + @schemas.classproperty + def ENABLED(cls): + return cls("ENABLED") + + + class name( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'name': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class notificationSource( + schemas.StrSchema + ): + pass + __annotations__ = { + "allowedRecipients": allowedRecipients, + "customDashboardUrl": customDashboardUrl, + "dashboardLinkVisibility": dashboardLinkVisibility, + "description": description, + "destination": destination, + "inPlatformNotification": inPlatformNotification, + "name": name, + "notificationSource": notificationSource, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["allowedRecipients"]) -> MetaOapg.properties.allowedRecipients: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["customDashboardUrl"]) -> MetaOapg.properties.customDashboardUrl: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardLinkVisibility"]) -> MetaOapg.properties.dashboardLinkVisibility: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["destination"]) -> MetaOapg.properties.destination: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["inPlatformNotification"]) -> MetaOapg.properties.inPlatformNotification: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["notificationSource"]) -> MetaOapg.properties.notificationSource: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["allowedRecipients", "customDashboardUrl", "dashboardLinkVisibility", "description", "destination", "inPlatformNotification", "name", "notificationSource", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["allowedRecipients"]) -> typing.Union[MetaOapg.properties.allowedRecipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["customDashboardUrl"]) -> typing.Union[MetaOapg.properties.customDashboardUrl, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardLinkVisibility"]) -> typing.Union[MetaOapg.properties.dashboardLinkVisibility, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["destination"]) -> typing.Union[MetaOapg.properties.destination, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["inPlatformNotification"]) -> typing.Union[MetaOapg.properties.inPlatformNotification, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["notificationSource"]) -> typing.Union[MetaOapg.properties.notificationSource, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["allowedRecipients", "customDashboardUrl", "dashboardLinkVisibility", "description", "destination", "inPlatformNotification", "name", "notificationSource", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + allowedRecipients: typing.Union[MetaOapg.properties.allowedRecipients, str, schemas.Unset] = schemas.unset, + customDashboardUrl: typing.Union[MetaOapg.properties.customDashboardUrl, str, schemas.Unset] = schemas.unset, + dashboardLinkVisibility: typing.Union[MetaOapg.properties.dashboardLinkVisibility, str, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, None, str, schemas.Unset] = schemas.unset, + destination: typing.Union[MetaOapg.properties.destination, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + inPlatformNotification: typing.Union[MetaOapg.properties.inPlatformNotification, str, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, None, str, schemas.Unset] = schemas.unset, + notificationSource: typing.Union[MetaOapg.properties.notificationSource, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + allowedRecipients=allowedRecipients, + customDashboardUrl=customDashboardUrl, + dashboardLinkVisibility=dashboardLinkVisibility, + description=description, + destination=destination, + inPlatformNotification=inPlatformNotification, + name=name, + notificationSource=notificationSource, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiNotificationChannelPatch': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.default_smtp import DefaultSmtp +from gooddata_api_client.model.in_platform import InPlatform +from gooddata_api_client.model.smtp import Smtp +from gooddata_api_client.model.webhook import Webhook diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_patch_document.pyi new file mode 100644 index 000000000..dff3a9783 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiNotificationChannelPatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiNotificationChannelPatch']: + return JsonApiNotificationChannelPatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiNotificationChannelPatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelPatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelPatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiNotificationChannelPatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiNotificationChannelPatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_notification_channel_patch import JsonApiNotificationChannelPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_post_optional_id.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_post_optional_id.pyi new file mode 100644 index 000000000..bca112d8f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_post_optional_id.pyi @@ -0,0 +1,383 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiNotificationChannelPostOptionalId( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of notificationChannel entity. + """ + + + class MetaOapg: + required = { + "type", + } + + class properties: + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class allowedRecipients( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def CREATOR(cls): + return cls("CREATOR") + + @schemas.classproperty + def INTERNAL(cls): + return cls("INTERNAL") + + @schemas.classproperty + def EXTERNAL(cls): + return cls("EXTERNAL") + + + class customDashboardUrl( + schemas.StrSchema + ): + pass + + + class dashboardLinkVisibility( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def HIDDEN(cls): + return cls("HIDDEN") + + @schemas.classproperty + def INTERNAL_ONLY(cls): + return cls("INTERNAL_ONLY") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + + class description( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'description': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class destination( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + DefaultSmtp, + InPlatform, + Smtp, + Webhook, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'destination': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class inPlatformNotification( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DISABLED(cls): + return cls("DISABLED") + + @schemas.classproperty + def ENABLED(cls): + return cls("ENABLED") + + + class name( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'name': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class notificationSource( + schemas.StrSchema + ): + pass + __annotations__ = { + "allowedRecipients": allowedRecipients, + "customDashboardUrl": customDashboardUrl, + "dashboardLinkVisibility": dashboardLinkVisibility, + "description": description, + "destination": destination, + "inPlatformNotification": inPlatformNotification, + "name": name, + "notificationSource": notificationSource, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["allowedRecipients"]) -> MetaOapg.properties.allowedRecipients: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["customDashboardUrl"]) -> MetaOapg.properties.customDashboardUrl: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardLinkVisibility"]) -> MetaOapg.properties.dashboardLinkVisibility: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["destination"]) -> MetaOapg.properties.destination: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["inPlatformNotification"]) -> MetaOapg.properties.inPlatformNotification: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["notificationSource"]) -> MetaOapg.properties.notificationSource: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["allowedRecipients", "customDashboardUrl", "dashboardLinkVisibility", "description", "destination", "inPlatformNotification", "name", "notificationSource", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["allowedRecipients"]) -> typing.Union[MetaOapg.properties.allowedRecipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["customDashboardUrl"]) -> typing.Union[MetaOapg.properties.customDashboardUrl, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardLinkVisibility"]) -> typing.Union[MetaOapg.properties.dashboardLinkVisibility, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["destination"]) -> typing.Union[MetaOapg.properties.destination, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["inPlatformNotification"]) -> typing.Union[MetaOapg.properties.inPlatformNotification, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["notificationSource"]) -> typing.Union[MetaOapg.properties.notificationSource, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["allowedRecipients", "customDashboardUrl", "dashboardLinkVisibility", "description", "destination", "inPlatformNotification", "name", "notificationSource", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + allowedRecipients: typing.Union[MetaOapg.properties.allowedRecipients, str, schemas.Unset] = schemas.unset, + customDashboardUrl: typing.Union[MetaOapg.properties.customDashboardUrl, str, schemas.Unset] = schemas.unset, + dashboardLinkVisibility: typing.Union[MetaOapg.properties.dashboardLinkVisibility, str, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, None, str, schemas.Unset] = schemas.unset, + destination: typing.Union[MetaOapg.properties.destination, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset] = schemas.unset, + inPlatformNotification: typing.Union[MetaOapg.properties.inPlatformNotification, str, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, None, str, schemas.Unset] = schemas.unset, + notificationSource: typing.Union[MetaOapg.properties.notificationSource, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + allowedRecipients=allowedRecipients, + customDashboardUrl=customDashboardUrl, + dashboardLinkVisibility=dashboardLinkVisibility, + description=description, + destination=destination, + inPlatformNotification=inPlatformNotification, + name=name, + notificationSource=notificationSource, + _configuration=_configuration, + **kwargs, + ) + + + class id( + schemas.StrSchema + ): + pass + __annotations__ = { + "type": type, + "attributes": attributes, + "id": id, + } + + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["type", "attributes", "id", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> typing.Union[MetaOapg.properties.id, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["type", "attributes", "id", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + id: typing.Union[MetaOapg.properties.id, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiNotificationChannelPostOptionalId': + return super().__new__( + cls, + *_args, + type=type, + attributes=attributes, + id=id, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.default_smtp import DefaultSmtp +from gooddata_api_client.model.in_platform import InPlatform +from gooddata_api_client.model.smtp import Smtp +from gooddata_api_client.model.webhook import Webhook diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_post_optional_id_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_post_optional_id_document.pyi new file mode 100644 index 000000000..1add63b62 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_post_optional_id_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiNotificationChannelPostOptionalIdDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiNotificationChannelPostOptionalId']: + return JsonApiNotificationChannelPostOptionalId + __annotations__ = { + "data": data, + } + + data: 'JsonApiNotificationChannelPostOptionalId' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelPostOptionalId': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelPostOptionalId': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiNotificationChannelPostOptionalId', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiNotificationChannelPostOptionalIdDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_notification_channel_post_optional_id import JsonApiNotificationChannelPostOptionalId diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_to_one_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_to_one_linkage.pyi new file mode 100644 index 000000000..d8d73ee4f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_to_one_linkage.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiNotificationChannelToOneLinkage( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + JsonApiNotificationChannelLinkage, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiNotificationChannelToOneLinkage': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_notification_channel_linkage import JsonApiNotificationChannelLinkage 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 03253faf1..d431d8652 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 @@ -61,6 +61,7 @@ class JsonApiOrganizationSettingInAttributes(ModelNormal): 'ACTIVE_THEME': "ACTIVE_THEME", 'ACTIVE_COLOR_PALETTE': "ACTIVE_COLOR_PALETTE", 'ACTIVE_LLM_ENDPOINT': "ACTIVE_LLM_ENDPOINT", + 'ACTIVE_LLM_PROVIDER': "ACTIVE_LLM_PROVIDER", 'ACTIVE_CALENDARS': "ACTIVE_CALENDARS", 'WHITE_LABELING': "WHITE_LABELING", 'LOCALE': "LOCALE", @@ -104,6 +105,7 @@ class JsonApiOrganizationSettingInAttributes(ModelNormal): '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", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_linkage.pyi new file mode 100644 index 000000000..130b721c1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_linkage.pyi @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiUserIdentifierLinkage( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + The \"type\" and \"id\" to non-empty members. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def USER_IDENTIFIER(cls): + return cls("userIdentifier") + __annotations__ = { + "id": id, + "type": type, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiUserIdentifierLinkage': + return super().__new__( + cls, + *_args, + id=id, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out.pyi new file mode 100644 index 000000000..4bebc4d89 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out.pyi @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiUserIdentifierOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of userIdentifier entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def USER_IDENTIFIER(cls): + return cls("userIdentifier") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class email( + schemas.StrSchema + ): + pass + + + class firstname( + schemas.StrSchema + ): + pass + + + class lastname( + schemas.StrSchema + ): + pass + __annotations__ = { + "email": email, + "firstname": firstname, + "lastname": lastname, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["firstname"]) -> MetaOapg.properties.firstname: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["lastname"]) -> MetaOapg.properties.lastname: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["email", "firstname", "lastname", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["email"]) -> typing.Union[MetaOapg.properties.email, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["firstname"]) -> typing.Union[MetaOapg.properties.firstname, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["lastname"]) -> typing.Union[MetaOapg.properties.lastname, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["email", "firstname", "lastname", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + email: typing.Union[MetaOapg.properties.email, str, schemas.Unset] = schemas.unset, + firstname: typing.Union[MetaOapg.properties.firstname, str, schemas.Unset] = schemas.unset, + lastname: typing.Union[MetaOapg.properties.lastname, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + email=email, + firstname=firstname, + lastname=lastname, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiUserIdentifierOut': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_document.pyi new file mode 100644 index 000000000..4feb64e0d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_document.pyi @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiUserIdentifierOutDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserIdentifierOut']: + return JsonApiUserIdentifierOut + + @staticmethod + def links() -> typing.Type['ObjectLinks']: + return ObjectLinks + __annotations__ = { + "data": data, + "links": links, + } + + data: 'JsonApiUserIdentifierOut' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierOut': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ObjectLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierOut': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ObjectLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserIdentifierOut', + links: typing.Union['ObjectLinks', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiUserIdentifierOutDocument': + return super().__new__( + cls, + *_args, + data=data, + links=links, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_user_identifier_out import JsonApiUserIdentifierOut +from gooddata_api_client.model.object_links import ObjectLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_list.pyi new file mode 100644 index 000000000..393e7a03f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_list.pyi @@ -0,0 +1,190 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiUserIdentifierOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiUserIdentifierOutWithLinks']: + return JsonApiUserIdentifierOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiUserIdentifierOutWithLinks'], typing.List['JsonApiUserIdentifierOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiUserIdentifierOutWithLinks': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiUserIdentifierOutList': + return super().__new__( + cls, + *_args, + data=data, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_with_links.pyi new file mode 100644 index 000000000..2b218203d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiUserIdentifierOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiUserIdentifierOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiUserIdentifierOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_user_identifier_out import JsonApiUserIdentifierOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_to_one_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_to_one_linkage.pyi new file mode 100644 index 000000000..1349821b5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_to_one_linkage.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiUserIdentifierToOneLinkage( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + JsonApiUserIdentifierLinkage, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiUserIdentifierToOneLinkage': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_user_identifier_linkage import JsonApiUserIdentifierLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_user_to_many_linkage.pyi new file mode 100644 index 000000000..d2d2265f5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_to_many_linkage.pyi @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiUserToManyLinkage( + schemas.ListSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + References to other resource objects in a to-many (\"relationship\"). Relationships can be specified by including a member in a resource's links object. + """ + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiUserLinkage']: + return JsonApiUserLinkage + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiUserLinkage'], typing.List['JsonApiUserLinkage']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'JsonApiUserToManyLinkage': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiUserLinkage': + return super().__getitem__(i) + +from gooddata_api_client.model.json_api_user_linkage import JsonApiUserLinkage 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 e0953d58e..56cc4b6a4 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 @@ -56,9 +56,17 @@ class JsonApiVisualizationObjectOutAttributes(ModelNormal): """ allowed_values = { + ('certification',): { + 'CERTIFIED': "CERTIFIED", + }, } validations = { + ('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 @@ -100,6 +108,9 @@ def openapi_types(): 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 'created_at': (datetime, none_type,), # noqa: E501 'description': (str,), # noqa: E501 'is_hidden': (bool,), # noqa: E501 @@ -116,6 +127,9 @@ def discriminator(): attribute_map = { '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 'description': 'description', # noqa: E501 'is_hidden': 'isHidden', # noqa: E501 @@ -169,6 +183,9 @@ 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 + 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 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 @@ -265,6 +282,9 @@ 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 + 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 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_to_one_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_to_one_linkage.pyi new file mode 100644 index 000000000..a31797177 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_to_one_linkage.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiVisualizationObjectToOneLinkage( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + JsonApiVisualizationObjectLinkage, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiVisualizationObjectToOneLinkage': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_visualization_object_linkage import JsonApiVisualizationObjectLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out.pyi new file mode 100644 index 000000000..fb2364941 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out.pyi @@ -0,0 +1,1895 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiWorkspaceAutomationOut( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of workspaceAutomation entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def WORKSPACE_AUTOMATION(cls): + return cls("workspaceAutomation") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class alert( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "execution", + "condition", + } + + class properties: + + @staticmethod + def condition() -> typing.Type['AlertCondition']: + return AlertCondition + + @staticmethod + def execution() -> typing.Type['AlertAfm']: + return AlertAfm + + + class interval( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DAY(cls): + return cls("DAY") + + @schemas.classproperty + def WEEK(cls): + return cls("WEEK") + + @schemas.classproperty + def MONTH(cls): + return cls("MONTH") + + @schemas.classproperty + def QUARTER(cls): + return cls("QUARTER") + + @schemas.classproperty + def YEAR(cls): + return cls("YEAR") + + + class trigger( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ALWAYS(cls): + return cls("ALWAYS") + + @schemas.classproperty + def ONCE(cls): + return cls("ONCE") + + @schemas.classproperty + def ONCE_PER_INTERVAL(cls): + return cls("ONCE_PER_INTERVAL") + __annotations__ = { + "condition": condition, + "execution": execution, + "interval": interval, + "trigger": trigger, + } + + execution: 'AlertAfm' + condition: 'AlertCondition' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["condition"]) -> 'AlertCondition': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["execution"]) -> 'AlertAfm': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["interval"]) -> MetaOapg.properties.interval: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["trigger"]) -> MetaOapg.properties.trigger: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["condition", "execution", "interval", "trigger", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["condition"]) -> 'AlertCondition': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["execution"]) -> 'AlertAfm': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["interval"]) -> typing.Union[MetaOapg.properties.interval, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["trigger"]) -> typing.Union[MetaOapg.properties.trigger, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["condition", "execution", "interval", "trigger", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + execution: 'AlertAfm', + condition: 'AlertCondition', + interval: typing.Union[MetaOapg.properties.interval, str, schemas.Unset] = schemas.unset, + trigger: typing.Union[MetaOapg.properties.trigger, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'alert': + return super().__new__( + cls, + *_args, + execution=execution, + condition=condition, + interval=interval, + trigger=trigger, + _configuration=_configuration, + **kwargs, + ) + areRelationsValid = schemas.BoolSchema + createdAt = schemas.DateTimeSchema + + + class dashboardTabularExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['DashboardTabularExportRequestV2']: + return DashboardTabularExportRequestV2 + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'DashboardTabularExportRequestV2' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'DashboardTabularExportRequestV2': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'DashboardTabularExportRequestV2': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'DashboardTabularExportRequestV2', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dashboardTabularExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class description( + schemas.StrSchema + ): + pass + + + class details( + schemas.DictSchema + ): + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'details': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class evaluationMode( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SHARED(cls): + return cls("SHARED") + + @schemas.classproperty + def PER_RECIPIENT(cls): + return cls("PER_RECIPIENT") + + + class externalRecipients( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "email", + } + + class properties: + email = schemas.StrSchema + __annotations__ = { + "email": email, + } + + email: MetaOapg.properties.email + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["email", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["email", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + email: typing.Union[MetaOapg.properties.email, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + email=email, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'externalRecipients': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class imageExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['ImageExportRequest']: + return ImageExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'ImageExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'ImageExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'ImageExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'ImageExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'imageExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class metadata( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin + ): + + + class MetaOapg: + + class properties: + + + class visibleFilters( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['VisibleFilter']: + return VisibleFilter + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['VisibleFilter'], typing.List['VisibleFilter']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visibleFilters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'VisibleFilter': + return super().__getitem__(i) + widget = schemas.StrSchema + __annotations__ = { + "visibleFilters": visibleFilters, + "widget": widget, + } + additional_properties = schemas.AnyTypeSchema + + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visibleFilters"]) -> MetaOapg.properties.visibleFilters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widget"]) -> MetaOapg.properties.widget: ... + + @typing.overload + def __getitem__(self, name: str) -> MetaOapg.additional_properties: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["visibleFilters"], typing_extensions.Literal["widget"], str, ]): + # dict_instance[name] accessor + return super().__getitem__(name) + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visibleFilters"]) -> typing.Union[MetaOapg.properties.visibleFilters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widget"]) -> typing.Union[MetaOapg.properties.widget, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[MetaOapg.additional_properties, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["visibleFilters"], typing_extensions.Literal["widget"], str, ]): + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + visibleFilters: typing.Union[MetaOapg.properties.visibleFilters, list, tuple, schemas.Unset] = schemas.unset, + widget: typing.Union[MetaOapg.properties.widget, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + ) -> 'metadata': + return super().__new__( + cls, + *_args, + visibleFilters=visibleFilters, + widget=widget, + _configuration=_configuration, + **kwargs, + ) + modifiedAt = schemas.DateTimeSchema + + + class rawExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['RawExportAutomationRequest']: + return RawExportAutomationRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'RawExportAutomationRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'RawExportAutomationRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'RawExportAutomationRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'RawExportAutomationRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'rawExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class schedule( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "cron", + "timezone", + } + + class properties: + + + class cron( + schemas.StrSchema + ): + pass + cronDescription = schemas.StrSchema + firstRun = schemas.DateTimeSchema + + + class timezone( + schemas.StrSchema + ): + pass + __annotations__ = { + "cron": cron, + "cronDescription": cronDescription, + "firstRun": firstRun, + "timezone": timezone, + } + + cron: MetaOapg.properties.cron + timezone: MetaOapg.properties.timezone + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["cron"]) -> MetaOapg.properties.cron: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["cronDescription"]) -> MetaOapg.properties.cronDescription: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["firstRun"]) -> MetaOapg.properties.firstRun: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["timezone"]) -> MetaOapg.properties.timezone: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["cron", "cronDescription", "firstRun", "timezone", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["cron"]) -> MetaOapg.properties.cron: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["cronDescription"]) -> typing.Union[MetaOapg.properties.cronDescription, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["firstRun"]) -> typing.Union[MetaOapg.properties.firstRun, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["timezone"]) -> MetaOapg.properties.timezone: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["cron", "cronDescription", "firstRun", "timezone", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + cron: typing.Union[MetaOapg.properties.cron, str, ], + timezone: typing.Union[MetaOapg.properties.timezone, str, ], + cronDescription: typing.Union[MetaOapg.properties.cronDescription, str, schemas.Unset] = schemas.unset, + firstRun: typing.Union[MetaOapg.properties.firstRun, str, datetime, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'schedule': + return super().__new__( + cls, + *_args, + cron=cron, + timezone=timezone, + cronDescription=cronDescription, + firstRun=firstRun, + _configuration=_configuration, + **kwargs, + ) + + + class slidesExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['SlidesExportRequest']: + return SlidesExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'SlidesExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'SlidesExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'SlidesExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'SlidesExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'slidesExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class state( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ACTIVE(cls): + return cls("ACTIVE") + + @schemas.classproperty + def PAUSED(cls): + return cls("PAUSED") + + + class tabularExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['TabularExportRequest']: + return TabularExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'TabularExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'TabularExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'TabularExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'TabularExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tabularExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + + + class visualExports( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "requestPayload", + } + + class properties: + + @staticmethod + def requestPayload() -> typing.Type['VisualExportRequest']: + return VisualExportRequest + __annotations__ = { + "requestPayload": requestPayload, + } + + requestPayload: 'VisualExportRequest' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["requestPayload"]) -> 'VisualExportRequest': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["requestPayload"]) -> 'VisualExportRequest': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["requestPayload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + requestPayload: 'VisualExportRequest', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + requestPayload=requestPayload, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visualExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "alert": alert, + "areRelationsValid": areRelationsValid, + "createdAt": createdAt, + "dashboardTabularExports": dashboardTabularExports, + "description": description, + "details": details, + "evaluationMode": evaluationMode, + "externalRecipients": externalRecipients, + "imageExports": imageExports, + "metadata": metadata, + "modifiedAt": modifiedAt, + "rawExports": rawExports, + "schedule": schedule, + "slidesExports": slidesExports, + "state": state, + "tabularExports": tabularExports, + "tags": tags, + "title": title, + "visualExports": visualExports, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["alert"]) -> MetaOapg.properties.alert: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["areRelationsValid"]) -> MetaOapg.properties.areRelationsValid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdAt"]) -> MetaOapg.properties.createdAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardTabularExports"]) -> MetaOapg.properties.dashboardTabularExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["details"]) -> MetaOapg.properties.details: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["evaluationMode"]) -> MetaOapg.properties.evaluationMode: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["externalRecipients"]) -> MetaOapg.properties.externalRecipients: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["imageExports"]) -> MetaOapg.properties.imageExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metadata"]) -> MetaOapg.properties.metadata: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedAt"]) -> MetaOapg.properties.modifiedAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rawExports"]) -> MetaOapg.properties.rawExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["schedule"]) -> MetaOapg.properties.schedule: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["slidesExports"]) -> MetaOapg.properties.slidesExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["state"]) -> MetaOapg.properties.state: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tabularExports"]) -> MetaOapg.properties.tabularExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualExports"]) -> MetaOapg.properties.visualExports: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["alert", "areRelationsValid", "createdAt", "dashboardTabularExports", "description", "details", "evaluationMode", "externalRecipients", "imageExports", "metadata", "modifiedAt", "rawExports", "schedule", "slidesExports", "state", "tabularExports", "tags", "title", "visualExports", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["alert"]) -> typing.Union[MetaOapg.properties.alert, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["areRelationsValid"]) -> typing.Union[MetaOapg.properties.areRelationsValid, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdAt"]) -> typing.Union[MetaOapg.properties.createdAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardTabularExports"]) -> typing.Union[MetaOapg.properties.dashboardTabularExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["details"]) -> typing.Union[MetaOapg.properties.details, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["evaluationMode"]) -> typing.Union[MetaOapg.properties.evaluationMode, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["externalRecipients"]) -> typing.Union[MetaOapg.properties.externalRecipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["imageExports"]) -> typing.Union[MetaOapg.properties.imageExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metadata"]) -> typing.Union[MetaOapg.properties.metadata, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedAt"]) -> typing.Union[MetaOapg.properties.modifiedAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rawExports"]) -> typing.Union[MetaOapg.properties.rawExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["schedule"]) -> typing.Union[MetaOapg.properties.schedule, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["slidesExports"]) -> typing.Union[MetaOapg.properties.slidesExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["state"]) -> typing.Union[MetaOapg.properties.state, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tabularExports"]) -> typing.Union[MetaOapg.properties.tabularExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualExports"]) -> typing.Union[MetaOapg.properties.visualExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["alert", "areRelationsValid", "createdAt", "dashboardTabularExports", "description", "details", "evaluationMode", "externalRecipients", "imageExports", "metadata", "modifiedAt", "rawExports", "schedule", "slidesExports", "state", "tabularExports", "tags", "title", "visualExports", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + alert: typing.Union[MetaOapg.properties.alert, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + areRelationsValid: typing.Union[MetaOapg.properties.areRelationsValid, bool, schemas.Unset] = schemas.unset, + createdAt: typing.Union[MetaOapg.properties.createdAt, str, datetime, schemas.Unset] = schemas.unset, + dashboardTabularExports: typing.Union[MetaOapg.properties.dashboardTabularExports, list, tuple, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + details: typing.Union[MetaOapg.properties.details, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + evaluationMode: typing.Union[MetaOapg.properties.evaluationMode, str, schemas.Unset] = schemas.unset, + externalRecipients: typing.Union[MetaOapg.properties.externalRecipients, list, tuple, schemas.Unset] = schemas.unset, + imageExports: typing.Union[MetaOapg.properties.imageExports, list, tuple, schemas.Unset] = schemas.unset, + metadata: typing.Union[MetaOapg.properties.metadata, dict, frozendict.frozendict, None, schemas.Unset] = schemas.unset, + modifiedAt: typing.Union[MetaOapg.properties.modifiedAt, str, datetime, schemas.Unset] = schemas.unset, + rawExports: typing.Union[MetaOapg.properties.rawExports, list, tuple, schemas.Unset] = schemas.unset, + schedule: typing.Union[MetaOapg.properties.schedule, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + slidesExports: typing.Union[MetaOapg.properties.slidesExports, list, tuple, schemas.Unset] = schemas.unset, + state: typing.Union[MetaOapg.properties.state, str, schemas.Unset] = schemas.unset, + tabularExports: typing.Union[MetaOapg.properties.tabularExports, list, tuple, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + visualExports: typing.Union[MetaOapg.properties.visualExports, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + alert=alert, + areRelationsValid=areRelationsValid, + createdAt=createdAt, + dashboardTabularExports=dashboardTabularExports, + description=description, + details=details, + evaluationMode=evaluationMode, + externalRecipients=externalRecipients, + imageExports=imageExports, + metadata=metadata, + modifiedAt=modifiedAt, + rawExports=rawExports, + schedule=schedule, + slidesExports=slidesExports, + state=state, + tabularExports=tabularExports, + tags=tags, + title=title, + visualExports=visualExports, + _configuration=_configuration, + **kwargs, + ) + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class analyticalDashboard( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAnalyticalDashboardToOneLinkage']: + return JsonApiAnalyticalDashboardToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAnalyticalDashboardToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAnalyticalDashboardToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAnalyticalDashboardToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'analyticalDashboard': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class automationResults( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiAutomationResultToManyLinkage']: + return JsonApiAutomationResultToManyLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiAutomationResultToManyLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAutomationResultToManyLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiAutomationResultToManyLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiAutomationResultToManyLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'automationResults': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class createdBy( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserIdentifierToOneLinkage']: + return JsonApiUserIdentifierToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserIdentifierToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserIdentifierToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'createdBy': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class exportDefinitions( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiExportDefinitionToManyLinkage']: + return JsonApiExportDefinitionToManyLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiExportDefinitionToManyLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportDefinitionToManyLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiExportDefinitionToManyLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiExportDefinitionToManyLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'exportDefinitions': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class modifiedBy( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserIdentifierToOneLinkage']: + return JsonApiUserIdentifierToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserIdentifierToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserIdentifierToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserIdentifierToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'modifiedBy': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class notificationChannel( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiNotificationChannelToOneLinkage']: + return JsonApiNotificationChannelToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiNotificationChannelToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiNotificationChannelToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiNotificationChannelToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'notificationChannel': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class recipients( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiUserToManyLinkage']: + return JsonApiUserToManyLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiUserToManyLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToManyLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiUserToManyLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiUserToManyLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'recipients': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + + + class workspace( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiWorkspaceToOneLinkage']: + return JsonApiWorkspaceToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiWorkspaceToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiWorkspaceToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'workspace': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "analyticalDashboard": analyticalDashboard, + "automationResults": automationResults, + "createdBy": createdBy, + "exportDefinitions": exportDefinitions, + "modifiedBy": modifiedBy, + "notificationChannel": notificationChannel, + "recipients": recipients, + "workspace": workspace, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["analyticalDashboard"]) -> MetaOapg.properties.analyticalDashboard: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["automationResults"]) -> MetaOapg.properties.automationResults: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdBy"]) -> MetaOapg.properties.createdBy: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["exportDefinitions"]) -> MetaOapg.properties.exportDefinitions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedBy"]) -> MetaOapg.properties.modifiedBy: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["notificationChannel"]) -> MetaOapg.properties.notificationChannel: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["recipients"]) -> MetaOapg.properties.recipients: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workspace"]) -> MetaOapg.properties.workspace: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "automationResults", "createdBy", "exportDefinitions", "modifiedBy", "notificationChannel", "recipients", "workspace", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["analyticalDashboard"]) -> typing.Union[MetaOapg.properties.analyticalDashboard, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["automationResults"]) -> typing.Union[MetaOapg.properties.automationResults, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdBy"]) -> typing.Union[MetaOapg.properties.createdBy, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["exportDefinitions"]) -> typing.Union[MetaOapg.properties.exportDefinitions, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedBy"]) -> typing.Union[MetaOapg.properties.modifiedBy, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["notificationChannel"]) -> typing.Union[MetaOapg.properties.notificationChannel, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["recipients"]) -> typing.Union[MetaOapg.properties.recipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workspace"]) -> typing.Union[MetaOapg.properties.workspace, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["analyticalDashboard", "automationResults", "createdBy", "exportDefinitions", "modifiedBy", "notificationChannel", "recipients", "workspace", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + analyticalDashboard: typing.Union[MetaOapg.properties.analyticalDashboard, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + automationResults: typing.Union[MetaOapg.properties.automationResults, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + createdBy: typing.Union[MetaOapg.properties.createdBy, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + exportDefinitions: typing.Union[MetaOapg.properties.exportDefinitions, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + modifiedBy: typing.Union[MetaOapg.properties.modifiedBy, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + notificationChannel: typing.Union[MetaOapg.properties.notificationChannel, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + recipients: typing.Union[MetaOapg.properties.recipients, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + workspace: typing.Union[MetaOapg.properties.workspace, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + analyticalDashboard=analyticalDashboard, + automationResults=automationResults, + createdBy=createdBy, + exportDefinitions=exportDefinitions, + modifiedBy=modifiedBy, + notificationChannel=notificationChannel, + recipients=recipients, + workspace=workspace, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + "relationships": relationships, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiWorkspaceAutomationOut': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.alert_afm import AlertAfm +from gooddata_api_client.model.alert_condition import AlertCondition +from gooddata_api_client.model.dashboard_tabular_export_request_v2 import DashboardTabularExportRequestV2 +from gooddata_api_client.model.image_export_request import ImageExportRequest +from gooddata_api_client.model.json_api_analytical_dashboard_to_one_linkage import JsonApiAnalyticalDashboardToOneLinkage +from gooddata_api_client.model.json_api_automation_result_to_many_linkage import JsonApiAutomationResultToManyLinkage +from gooddata_api_client.model.json_api_export_definition_to_many_linkage import JsonApiExportDefinitionToManyLinkage +from gooddata_api_client.model.json_api_notification_channel_to_one_linkage import JsonApiNotificationChannelToOneLinkage +from gooddata_api_client.model.json_api_user_identifier_to_one_linkage import JsonApiUserIdentifierToOneLinkage +from gooddata_api_client.model.json_api_user_to_many_linkage import JsonApiUserToManyLinkage +from gooddata_api_client.model.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage +from gooddata_api_client.model.raw_export_automation_request import RawExportAutomationRequest +from gooddata_api_client.model.slides_export_request import SlidesExportRequest +from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.model.visible_filter import VisibleFilter +from gooddata_api_client.model.visual_export_request import VisualExportRequest diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_includes.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_includes.pyi new file mode 100644 index 000000000..2d5431393 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_includes.pyi @@ -0,0 +1,79 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiWorkspaceAutomationOutIncludes( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + JsonApiWorkspaceOutWithLinks, + JsonApiNotificationChannelOutWithLinks, + JsonApiAnalyticalDashboardOutWithLinks, + JsonApiUserIdentifierOutWithLinks, + JsonApiExportDefinitionOutWithLinks, + JsonApiUserOutWithLinks, + JsonApiAutomationResultOutWithLinks, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiWorkspaceAutomationOutIncludes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks +from gooddata_api_client.model.json_api_automation_result_out_with_links import JsonApiAutomationResultOutWithLinks +from gooddata_api_client.model.json_api_export_definition_out_with_links import JsonApiExportDefinitionOutWithLinks +from gooddata_api_client.model.json_api_notification_channel_out_with_links import JsonApiNotificationChannelOutWithLinks +from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks +from gooddata_api_client.model.json_api_user_out_with_links import JsonApiUserOutWithLinks +from gooddata_api_client.model.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_list.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_list.pyi new file mode 100644 index 000000000..58648fd56 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_list.pyi @@ -0,0 +1,226 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiWorkspaceAutomationOutList( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A JSON:API document with a list of resources + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiWorkspaceAutomationOutWithLinks']: + return JsonApiWorkspaceAutomationOutWithLinks + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiWorkspaceAutomationOutWithLinks'], typing.List['JsonApiWorkspaceAutomationOutWithLinks']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiWorkspaceAutomationOutWithLinks': + return super().__getitem__(i) + + + class included( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiWorkspaceAutomationOutIncludes']: + return JsonApiWorkspaceAutomationOutIncludes + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiWorkspaceAutomationOutIncludes'], typing.List['JsonApiWorkspaceAutomationOutIncludes']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'included': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiWorkspaceAutomationOutIncludes': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ListLinks']: + return ListLinks + + + class meta( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def page() -> typing.Type['PageMetadata']: + return PageMetadata + __annotations__ = { + "page": page, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["page"]) -> 'PageMetadata': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["page"]) -> typing.Union['PageMetadata', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["page", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + page: typing.Union['PageMetadata', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'meta': + return super().__new__( + cls, + *_args, + page=page, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "data": data, + "included": included, + "links": links, + "meta": meta, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["included"]) -> MetaOapg.properties.included: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ListLinks': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> MetaOapg.properties.meta: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["included"]) -> typing.Union[MetaOapg.properties.included, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> typing.Union['ListLinks', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> typing.Union[MetaOapg.properties.meta, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "included", "links", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + included: typing.Union[MetaOapg.properties.included, list, tuple, schemas.Unset] = schemas.unset, + links: typing.Union['ListLinks', schemas.Unset] = schemas.unset, + meta: typing.Union[MetaOapg.properties.meta, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiWorkspaceAutomationOutList': + return super().__new__( + cls, + *_args, + data=data, + included=included, + links=links, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_workspace_automation_out_includes import JsonApiWorkspaceAutomationOutIncludes +from gooddata_api_client.model.json_api_workspace_automation_out_with_links import JsonApiWorkspaceAutomationOutWithLinks +from gooddata_api_client.model.list_links import ListLinks +from gooddata_api_client.model.page_metadata import PageMetadata diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_relationships.py index 1608b606e..6860275f8 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_relationships.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_relationships.py @@ -31,14 +31,14 @@ def lazy_import(): - from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_certified_by import JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy 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_workspace_automation_out_relationships_workspace import JsonApiWorkspaceAutomationOutRelationshipsWorkspace - globals()['JsonApiAnalyticalDashboardOutRelationshipsCreatedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCreatedBy + globals()['JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy'] = JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy globals()['JsonApiAutomationInRelationshipsAnalyticalDashboard'] = JsonApiAutomationInRelationshipsAnalyticalDashboard globals()['JsonApiAutomationInRelationshipsExportDefinitions'] = JsonApiAutomationInRelationshipsExportDefinitions globals()['JsonApiAutomationInRelationshipsNotificationChannel'] = JsonApiAutomationInRelationshipsNotificationChannel @@ -102,9 +102,9 @@ def openapi_types(): return { 'analytical_dashboard': (JsonApiAutomationInRelationshipsAnalyticalDashboard,), # noqa: E501 'automation_results': (JsonApiAutomationOutRelationshipsAutomationResults,), # noqa: E501 - 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 + 'created_by': (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy,), # noqa: E501 'export_definitions': (JsonApiAutomationInRelationshipsExportDefinitions,), # noqa: E501 - 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy,), # noqa: E501 + 'modified_by': (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy,), # noqa: E501 'notification_channel': (JsonApiAutomationInRelationshipsNotificationChannel,), # noqa: E501 'recipients': (JsonApiAutomationInRelationshipsRecipients,), # noqa: E501 'workspace': (JsonApiWorkspaceAutomationOutRelationshipsWorkspace,), # noqa: E501 @@ -169,9 +169,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 automation_results (JsonApiAutomationOutRelationshipsAutomationResults): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + created_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 export_definitions (JsonApiAutomationInRelationshipsExportDefinitions): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + modified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 notification_channel (JsonApiAutomationInRelationshipsNotificationChannel): [optional] # noqa: E501 recipients (JsonApiAutomationInRelationshipsRecipients): [optional] # noqa: E501 workspace (JsonApiWorkspaceAutomationOutRelationshipsWorkspace): [optional] # noqa: E501 @@ -262,9 +262,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 automation_results (JsonApiAutomationOutRelationshipsAutomationResults): [optional] # noqa: E501 - created_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + created_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 export_definitions (JsonApiAutomationInRelationshipsExportDefinitions): [optional] # noqa: E501 - modified_by (JsonApiAnalyticalDashboardOutRelationshipsCreatedBy): [optional] # noqa: E501 + modified_by (JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy): [optional] # noqa: E501 notification_channel (JsonApiAutomationInRelationshipsNotificationChannel): [optional] # noqa: E501 recipients (JsonApiAutomationInRelationshipsRecipients): [optional] # noqa: E501 workspace (JsonApiWorkspaceAutomationOutRelationshipsWorkspace): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_with_links.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_with_links.pyi new file mode 100644 index 000000000..e6d112f25 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_with_links.pyi @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiWorkspaceAutomationOutWithLinks( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + JsonApiWorkspaceAutomationOut, + ObjectLinksContainer, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiWorkspaceAutomationOutWithLinks': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_workspace_automation_out import JsonApiWorkspaceAutomationOut +from gooddata_api_client.model.object_links_container import ObjectLinksContainer diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in.pyi new file mode 100644 index 000000000..396af1b71 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in.pyi @@ -0,0 +1,341 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiWorkspaceDataFilterSettingIn( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of workspaceDataFilterSetting entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def WORKSPACE_DATA_FILTER_SETTING(cls): + return cls("workspaceDataFilterSetting") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class description( + schemas.StrSchema + ): + pass + + + class filterValues( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'filterValues': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "description": description, + "filterValues": filterValues, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filterValues"]) -> MetaOapg.properties.filterValues: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["description", "filterValues", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filterValues"]) -> typing.Union[MetaOapg.properties.filterValues, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["description", "filterValues", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + filterValues: typing.Union[MetaOapg.properties.filterValues, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + description=description, + filterValues=filterValues, + title=title, + _configuration=_configuration, + **kwargs, + ) + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class workspaceDataFilter( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiWorkspaceDataFilterToOneLinkage']: + return JsonApiWorkspaceDataFilterToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiWorkspaceDataFilterToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiWorkspaceDataFilterToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'workspaceDataFilter': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "workspaceDataFilter": workspaceDataFilter, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workspaceDataFilter"]) -> MetaOapg.properties.workspaceDataFilter: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["workspaceDataFilter", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workspaceDataFilter"]) -> typing.Union[MetaOapg.properties.workspaceDataFilter, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["workspaceDataFilter", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + workspaceDataFilter: typing.Union[MetaOapg.properties.workspaceDataFilter, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + workspaceDataFilter=workspaceDataFilter, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + "relationships": relationships, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiWorkspaceDataFilterSettingIn': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_workspace_data_filter_to_one_linkage import JsonApiWorkspaceDataFilterToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in_document.pyi new file mode 100644 index 000000000..95824884d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_in_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiWorkspaceDataFilterSettingInDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiWorkspaceDataFilterSettingIn']: + return JsonApiWorkspaceDataFilterSettingIn + __annotations__ = { + "data": data, + } + + data: 'JsonApiWorkspaceDataFilterSettingIn' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterSettingIn': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterSettingIn': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiWorkspaceDataFilterSettingIn', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiWorkspaceDataFilterSettingInDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_workspace_data_filter_setting_in import JsonApiWorkspaceDataFilterSettingIn diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_patch.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_patch.pyi new file mode 100644 index 000000000..52f2792b0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_patch.pyi @@ -0,0 +1,341 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiWorkspaceDataFilterSettingPatch( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + JSON:API representation of patching workspaceDataFilterSetting entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + + + class id( + schemas.StrSchema + ): + pass + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def WORKSPACE_DATA_FILTER_SETTING(cls): + return cls("workspaceDataFilterSetting") + + + class attributes( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class description( + schemas.StrSchema + ): + pass + + + class filterValues( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'filterValues': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class title( + schemas.StrSchema + ): + pass + __annotations__ = { + "description": description, + "filterValues": filterValues, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filterValues"]) -> MetaOapg.properties.filterValues: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["description", "filterValues", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filterValues"]) -> typing.Union[MetaOapg.properties.filterValues, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["description", "filterValues", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + filterValues: typing.Union[MetaOapg.properties.filterValues, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'attributes': + return super().__new__( + cls, + *_args, + description=description, + filterValues=filterValues, + title=title, + _configuration=_configuration, + **kwargs, + ) + + + class relationships( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class workspaceDataFilter( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiWorkspaceDataFilterToOneLinkage']: + return JsonApiWorkspaceDataFilterToOneLinkage + __annotations__ = { + "data": data, + } + + data: 'JsonApiWorkspaceDataFilterToOneLinkage' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterToOneLinkage': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterToOneLinkage': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiWorkspaceDataFilterToOneLinkage', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'workspaceDataFilter': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "workspaceDataFilter": workspaceDataFilter, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workspaceDataFilter"]) -> MetaOapg.properties.workspaceDataFilter: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["workspaceDataFilter", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workspaceDataFilter"]) -> typing.Union[MetaOapg.properties.workspaceDataFilter, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["workspaceDataFilter", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + workspaceDataFilter: typing.Union[MetaOapg.properties.workspaceDataFilter, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'relationships': + return super().__new__( + cls, + *_args, + workspaceDataFilter=workspaceDataFilter, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "id": id, + "type": type, + "attributes": attributes, + "relationships": relationships, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> typing.Union[MetaOapg.properties.attributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> typing.Union[MetaOapg.properties.relationships, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "attributes", "relationships", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + relationships: typing.Union[MetaOapg.properties.relationships, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiWorkspaceDataFilterSettingPatch': + return super().__new__( + cls, + *_args, + id=id, + type=type, + attributes=attributes, + relationships=relationships, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_workspace_data_filter_to_one_linkage import JsonApiWorkspaceDataFilterToOneLinkage diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_patch_document.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_patch_document.pyi new file mode 100644 index 000000000..bcb0b89a8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_patch_document.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiWorkspaceDataFilterSettingPatchDocument( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + @staticmethod + def data() -> typing.Type['JsonApiWorkspaceDataFilterSettingPatch']: + return JsonApiWorkspaceDataFilterSettingPatch + __annotations__ = { + "data": data, + } + + data: 'JsonApiWorkspaceDataFilterSettingPatch' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterSettingPatch': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'JsonApiWorkspaceDataFilterSettingPatch': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'JsonApiWorkspaceDataFilterSettingPatch', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonApiWorkspaceDataFilterSettingPatchDocument': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch import JsonApiWorkspaceDataFilterSettingPatch diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_to_many_linkage.pyi b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_to_many_linkage.pyi new file mode 100644 index 000000000..db501bcbe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_to_many_linkage.pyi @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonApiWorkspaceDataFilterToManyLinkage( + schemas.ListSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + References to other resource objects in a to-many (\"relationship\"). Relationships can be specified by including a member in a resource's links object. + """ + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['JsonApiWorkspaceDataFilterLinkage']: + return JsonApiWorkspaceDataFilterLinkage + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['JsonApiWorkspaceDataFilterLinkage'], typing.List['JsonApiWorkspaceDataFilterLinkage']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'JsonApiWorkspaceDataFilterToManyLinkage': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'JsonApiWorkspaceDataFilterLinkage': + return super().__getitem__(i) + +from gooddata_api_client.model.json_api_workspace_data_filter_linkage import JsonApiWorkspaceDataFilterLinkage 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 5771a0633..f729ee064 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 @@ -72,6 +72,8 @@ class JsonApiWorkspaceOutMeta(ModelNormal): 'EXPORT_PDF': "EXPORT_PDF", 'CREATE_AUTOMATION': "CREATE_AUTOMATION", 'USE_AI_ASSISTANT': "USE_AI_ASSISTANT", + 'WRITE_KNOWLEDGE_DOCUMENTS': "WRITE_KNOWLEDGE_DOCUMENTS", + 'READ_KNOWLEDGE_DOCUMENTS': "READ_KNOWLEDGE_DOCUMENTS", 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", 'VIEW': "VIEW", }, diff --git a/gooddata-api-client/gooddata_api_client/model/json_node.pyi b/gooddata-api-client/gooddata_api_client/model/json_node.pyi new file mode 100644 index 000000000..f9bf14e2e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_node.pyi @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class JsonNode( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Free-form JSON object + """ + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'JsonNode': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/key_drivers_dimension.pyi b/gooddata-api-client/gooddata_api_client/model/key_drivers_dimension.pyi new file mode 100644 index 000000000..5b35c882f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/key_drivers_dimension.pyi @@ -0,0 +1,276 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class KeyDriversDimension( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "attributeName", + "attribute", + "label", + "labelName", + } + + class properties: + + @staticmethod + def attribute() -> typing.Type['RestApiIdentifier']: + return RestApiIdentifier + attributeName = schemas.StrSchema + + @staticmethod + def label() -> typing.Type['RestApiIdentifier']: + return RestApiIdentifier + labelName = schemas.StrSchema + + @staticmethod + def format() -> typing.Type['AttributeFormat']: + return AttributeFormat + + + class granularity( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MINUTE(cls): + return cls("MINUTE") + + @schemas.classproperty + def HOUR(cls): + return cls("HOUR") + + @schemas.classproperty + def DAY(cls): + return cls("DAY") + + @schemas.classproperty + def WEEK(cls): + return cls("WEEK") + + @schemas.classproperty + def MONTH(cls): + return cls("MONTH") + + @schemas.classproperty + def QUARTER(cls): + return cls("QUARTER") + + @schemas.classproperty + def YEAR(cls): + return cls("YEAR") + + @schemas.classproperty + def MINUTE_OF_HOUR(cls): + return cls("MINUTE_OF_HOUR") + + @schemas.classproperty + def HOUR_OF_DAY(cls): + return cls("HOUR_OF_DAY") + + @schemas.classproperty + def DAY_OF_WEEK(cls): + return cls("DAY_OF_WEEK") + + @schemas.classproperty + def DAY_OF_MONTH(cls): + return cls("DAY_OF_MONTH") + + @schemas.classproperty + def DAY_OF_QUARTER(cls): + return cls("DAY_OF_QUARTER") + + @schemas.classproperty + def DAY_OF_YEAR(cls): + return cls("DAY_OF_YEAR") + + @schemas.classproperty + def WEEK_OF_YEAR(cls): + return cls("WEEK_OF_YEAR") + + @schemas.classproperty + def MONTH_OF_YEAR(cls): + return cls("MONTH_OF_YEAR") + + @schemas.classproperty + def QUARTER_OF_YEAR(cls): + return cls("QUARTER_OF_YEAR") + + @schemas.classproperty + def FISCAL_MONTH(cls): + return cls("FISCAL_MONTH") + + @schemas.classproperty + def FISCAL_QUARTER(cls): + return cls("FISCAL_QUARTER") + + @schemas.classproperty + def FISCAL_YEAR(cls): + return cls("FISCAL_YEAR") + + + class valueType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def TEXT(cls): + return cls("TEXT") + + @schemas.classproperty + def HYPERLINK(cls): + return cls("HYPERLINK") + + @schemas.classproperty + def GEO(cls): + return cls("GEO") + + @schemas.classproperty + def GEO_LONGITUDE(cls): + return cls("GEO_LONGITUDE") + + @schemas.classproperty + def GEO_LATITUDE(cls): + return cls("GEO_LATITUDE") + + @schemas.classproperty + def GEO_AREA(cls): + return cls("GEO_AREA") + + @schemas.classproperty + def IMAGE(cls): + return cls("IMAGE") + __annotations__ = { + "attribute": attribute, + "attributeName": attributeName, + "label": label, + "labelName": labelName, + "format": format, + "granularity": granularity, + "valueType": valueType, + } + + attributeName: MetaOapg.properties.attributeName + attribute: 'RestApiIdentifier' + label: 'RestApiIdentifier' + labelName: MetaOapg.properties.labelName + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attribute"]) -> 'RestApiIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributeName"]) -> MetaOapg.properties.attributeName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["label"]) -> 'RestApiIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["labelName"]) -> MetaOapg.properties.labelName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["format"]) -> 'AttributeFormat': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["valueType"]) -> MetaOapg.properties.valueType: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attribute", "attributeName", "label", "labelName", "format", "granularity", "valueType", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attribute"]) -> 'RestApiIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributeName"]) -> MetaOapg.properties.attributeName: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["label"]) -> 'RestApiIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["labelName"]) -> MetaOapg.properties.labelName: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["format"]) -> typing.Union['AttributeFormat', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["granularity"]) -> typing.Union[MetaOapg.properties.granularity, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["valueType"]) -> typing.Union[MetaOapg.properties.valueType, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attribute", "attributeName", "label", "labelName", "format", "granularity", "valueType", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributeName: typing.Union[MetaOapg.properties.attributeName, str, ], + attribute: 'RestApiIdentifier', + label: 'RestApiIdentifier', + labelName: typing.Union[MetaOapg.properties.labelName, str, ], + format: typing.Union['AttributeFormat', schemas.Unset] = schemas.unset, + granularity: typing.Union[MetaOapg.properties.granularity, str, schemas.Unset] = schemas.unset, + valueType: typing.Union[MetaOapg.properties.valueType, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'KeyDriversDimension': + return super().__new__( + cls, + *_args, + attributeName=attributeName, + attribute=attribute, + label=label, + labelName=labelName, + format=format, + granularity=granularity, + valueType=valueType, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.attribute_format import AttributeFormat +from gooddata_api_client.model.rest_api_identifier import RestApiIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/key_drivers_request.pyi b/gooddata-api-client/gooddata_api_client/model/key_drivers_request.pyi new file mode 100644 index 000000000..b88cc610e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/key_drivers_request.pyi @@ -0,0 +1,147 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class KeyDriversRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "metric", + } + + class properties: + + @staticmethod + def metric() -> typing.Type['MeasureItem']: + return MeasureItem + + + class auxMetrics( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['MeasureItem']: + return MeasureItem + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['MeasureItem'], typing.List['MeasureItem']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'auxMetrics': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'MeasureItem': + return super().__getitem__(i) + + + class sortDirection( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ASC(cls): + return cls("ASC") + + @schemas.classproperty + def DESC(cls): + return cls("DESC") + __annotations__ = { + "metric": metric, + "auxMetrics": auxMetrics, + "sortDirection": sortDirection, + } + + metric: 'MeasureItem' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metric"]) -> 'MeasureItem': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["auxMetrics"]) -> MetaOapg.properties.auxMetrics: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sortDirection"]) -> MetaOapg.properties.sortDirection: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["metric", "auxMetrics", "sortDirection", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metric"]) -> 'MeasureItem': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["auxMetrics"]) -> typing.Union[MetaOapg.properties.auxMetrics, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sortDirection"]) -> typing.Union[MetaOapg.properties.sortDirection, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["metric", "auxMetrics", "sortDirection", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + metric: 'MeasureItem', + auxMetrics: typing.Union[MetaOapg.properties.auxMetrics, list, tuple, schemas.Unset] = schemas.unset, + sortDirection: typing.Union[MetaOapg.properties.sortDirection, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'KeyDriversRequest': + return super().__new__( + cls, + *_args, + metric=metric, + auxMetrics=auxMetrics, + sortDirection=sortDirection, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.measure_item import MeasureItem diff --git a/gooddata-api-client/gooddata_api_client/model/key_drivers_response.pyi b/gooddata-api-client/gooddata_api_client/model/key_drivers_response.pyi new file mode 100644 index 000000000..b97e4630f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/key_drivers_response.pyi @@ -0,0 +1,127 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class KeyDriversResponse( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "links", + "dimensions", + } + + class properties: + + + class dimensions( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['KeyDriversDimension']: + return KeyDriversDimension + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['KeyDriversDimension'], typing.List['KeyDriversDimension']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dimensions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'KeyDriversDimension': + return super().__getitem__(i) + + @staticmethod + def links() -> typing.Type['ExecutionLinks']: + return ExecutionLinks + __annotations__ = { + "dimensions": dimensions, + "links": links, + } + + links: 'ExecutionLinks' + dimensions: MetaOapg.properties.dimensions + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dimensions"]) -> MetaOapg.properties.dimensions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ExecutionLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dimensions", "links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dimensions"]) -> MetaOapg.properties.dimensions: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> 'ExecutionLinks': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dimensions", "links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + links: 'ExecutionLinks', + dimensions: typing.Union[MetaOapg.properties.dimensions, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'KeyDriversResponse': + return super().__new__( + cls, + *_args, + links=links, + dimensions=dimensions, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.execution_links import ExecutionLinks +from gooddata_api_client.model.key_drivers_dimension import KeyDriversDimension diff --git a/gooddata-api-client/gooddata_api_client/model/key_drivers_result.pyi b/gooddata-api-client/gooddata_api_client/model/key_drivers_result.pyi new file mode 100644 index 000000000..a93283390 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/key_drivers_result.pyi @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class KeyDriversResult( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + data = schemas.DictSchema + __annotations__ = { + "data": data, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'KeyDriversResult': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/knowledge_document_metadata_dto.py b/gooddata-api-client/gooddata_api_client/model/knowledge_document_metadata_dto.py new file mode 100644 index 000000000..0b6ad1732 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/knowledge_document_metadata_dto.py @@ -0,0 +1,318 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + 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 KnowledgeDocumentMetadataDto(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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_at': (str,), # noqa: E501 + 'created_by': (str,), # noqa: E501 + 'filename': (str,), # noqa: E501 + 'num_chunks': (int,), # noqa: E501 + 'scopes': ([str],), # noqa: E501 + 'updated_at': (str,), # noqa: E501 + 'updated_by': (str,), # noqa: E501 + 'is_disabled': (bool,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'workspace_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'created_at': 'createdAt', # noqa: E501 + 'created_by': 'createdBy', # noqa: E501 + 'filename': 'filename', # noqa: E501 + 'num_chunks': 'numChunks', # noqa: E501 + 'scopes': 'scopes', # noqa: E501 + 'updated_at': 'updatedAt', # noqa: E501 + 'updated_by': 'updatedBy', # noqa: E501 + 'is_disabled': 'isDisabled', # noqa: E501 + 'title': 'title', # noqa: E501 + 'workspace_id': 'workspaceId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, created_at, created_by, filename, num_chunks, scopes, updated_at, updated_by, *args, **kwargs): # noqa: E501 + """KnowledgeDocumentMetadataDto - a model defined in OpenAPI + + Args: + created_at (str): + created_by (str): + filename (str): + num_chunks (int): + scopes ([str]): + updated_at (str): + updated_by (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,) + is_disabled (bool): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + workspace_id (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.created_at = created_at + self.created_by = created_by + self.filename = filename + self.num_chunks = num_chunks + self.scopes = scopes + self.updated_at = updated_at + self.updated_by = updated_by + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = 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_at, created_by, filename, num_chunks, scopes, updated_at, updated_by, *args, **kwargs): # noqa: E501 + """KnowledgeDocumentMetadataDto - a model defined in OpenAPI + + Args: + created_at (str): + created_by (str): + filename (str): + num_chunks (int): + scopes ([str]): + updated_at (str): + updated_by (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,) + is_disabled (bool): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + workspace_id (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.created_at = created_at + self.created_by = created_by + self.filename = filename + self.num_chunks = num_chunks + self.scopes = scopes + self.updated_at = updated_at + self.updated_by = updated_by + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/knowledge_document_metadata_dto.pyi b/gooddata-api-client/gooddata_api_client/model/knowledge_document_metadata_dto.pyi new file mode 100644 index 000000000..c05486362 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/knowledge_document_metadata_dto.pyi @@ -0,0 +1,208 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class KnowledgeDocumentMetadataDto( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "createdAt", + "numChunks", + "filename", + "updatedBy", + "createdBy", + "scopes", + "updatedAt", + } + + class properties: + createdAt = schemas.StrSchema + createdBy = schemas.StrSchema + filename = schemas.StrSchema + numChunks = schemas.Int32Schema + + + class scopes( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'scopes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + updatedAt = schemas.StrSchema + updatedBy = schemas.StrSchema + isDisabled = schemas.BoolSchema + title = schemas.StrSchema + workspaceId = schemas.StrSchema + __annotations__ = { + "createdAt": createdAt, + "createdBy": createdBy, + "filename": filename, + "numChunks": numChunks, + "scopes": scopes, + "updatedAt": updatedAt, + "updatedBy": updatedBy, + "isDisabled": isDisabled, + "title": title, + "workspaceId": workspaceId, + } + + createdAt: MetaOapg.properties.createdAt + numChunks: MetaOapg.properties.numChunks + filename: MetaOapg.properties.filename + updatedBy: MetaOapg.properties.updatedBy + createdBy: MetaOapg.properties.createdBy + scopes: MetaOapg.properties.scopes + updatedAt: MetaOapg.properties.updatedAt + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdAt"]) -> MetaOapg.properties.createdAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdBy"]) -> MetaOapg.properties.createdBy: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filename"]) -> MetaOapg.properties.filename: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["numChunks"]) -> MetaOapg.properties.numChunks: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["scopes"]) -> MetaOapg.properties.scopes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["updatedAt"]) -> MetaOapg.properties.updatedAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["updatedBy"]) -> MetaOapg.properties.updatedBy: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isDisabled"]) -> MetaOapg.properties.isDisabled: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workspaceId"]) -> MetaOapg.properties.workspaceId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["createdAt", "createdBy", "filename", "numChunks", "scopes", "updatedAt", "updatedBy", "isDisabled", "title", "workspaceId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdAt"]) -> MetaOapg.properties.createdAt: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdBy"]) -> MetaOapg.properties.createdBy: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filename"]) -> MetaOapg.properties.filename: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["numChunks"]) -> MetaOapg.properties.numChunks: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["scopes"]) -> MetaOapg.properties.scopes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["updatedAt"]) -> MetaOapg.properties.updatedAt: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["updatedBy"]) -> MetaOapg.properties.updatedBy: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isDisabled"]) -> typing.Union[MetaOapg.properties.isDisabled, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workspaceId"]) -> typing.Union[MetaOapg.properties.workspaceId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["createdAt", "createdBy", "filename", "numChunks", "scopes", "updatedAt", "updatedBy", "isDisabled", "title", "workspaceId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + createdAt: typing.Union[MetaOapg.properties.createdAt, str, ], + numChunks: typing.Union[MetaOapg.properties.numChunks, decimal.Decimal, int, ], + filename: typing.Union[MetaOapg.properties.filename, str, ], + updatedBy: typing.Union[MetaOapg.properties.updatedBy, str, ], + createdBy: typing.Union[MetaOapg.properties.createdBy, str, ], + scopes: typing.Union[MetaOapg.properties.scopes, list, tuple, ], + updatedAt: typing.Union[MetaOapg.properties.updatedAt, str, ], + isDisabled: typing.Union[MetaOapg.properties.isDisabled, bool, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + workspaceId: typing.Union[MetaOapg.properties.workspaceId, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'KnowledgeDocumentMetadataDto': + return super().__new__( + cls, + *_args, + createdAt=createdAt, + numChunks=numChunks, + filename=filename, + updatedBy=updatedBy, + createdBy=createdBy, + scopes=scopes, + updatedAt=updatedAt, + isDisabled=isDisabled, + title=title, + workspaceId=workspaceId, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/knowledge_search_result_dto.py b/gooddata-api-client/gooddata_api_client/model/knowledge_search_result_dto.py new file mode 100644 index 000000000..de120c6cd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/knowledge_search_result_dto.py @@ -0,0 +1,314 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class KnowledgeSearchResultDto(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'chunk_index': (int,), # noqa: E501 + 'content': (str,), # noqa: E501 + 'filename': (str,), # noqa: E501 + 'page_numbers': ([int],), # noqa: E501 + 'scopes': ([str],), # noqa: E501 + 'score': (float,), # noqa: E501 + 'total_chunks': (int,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'workspace_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'chunk_index': 'chunkIndex', # noqa: E501 + 'content': 'content', # noqa: E501 + 'filename': 'filename', # noqa: E501 + 'page_numbers': 'pageNumbers', # noqa: E501 + 'scopes': 'scopes', # noqa: E501 + 'score': 'score', # noqa: E501 + 'total_chunks': 'totalChunks', # noqa: E501 + 'title': 'title', # noqa: E501 + 'workspace_id': 'workspaceId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, chunk_index, content, filename, page_numbers, scopes, score, total_chunks, *args, **kwargs): # noqa: E501 + """KnowledgeSearchResultDto - a model defined in OpenAPI + + Args: + chunk_index (int): + content (str): + filename (str): + page_numbers ([int]): + scopes ([str]): + score (float): + total_chunks (int): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + title (str): [optional] # noqa: E501 + workspace_id (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.chunk_index = chunk_index + self.content = content + self.filename = filename + self.page_numbers = page_numbers + self.scopes = scopes + self.score = score + self.total_chunks = total_chunks + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, chunk_index, content, filename, page_numbers, scopes, score, total_chunks, *args, **kwargs): # noqa: E501 + """KnowledgeSearchResultDto - a model defined in OpenAPI + + Args: + chunk_index (int): + content (str): + filename (str): + page_numbers ([int]): + scopes ([str]): + score (float): + total_chunks (int): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + title (str): [optional] # noqa: E501 + workspace_id (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.chunk_index = chunk_index + self.content = content + self.filename = filename + self.page_numbers = page_numbers + self.scopes = scopes + self.score = score + self.total_chunks = total_chunks + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/knowledge_search_result_dto.pyi b/gooddata-api-client/gooddata_api_client/model/knowledge_search_result_dto.pyi new file mode 100644 index 000000000..2534a457d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/knowledge_search_result_dto.pyi @@ -0,0 +1,220 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class KnowledgeSearchResultDto( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "score", + "filename", + "pageNumbers", + "totalChunks", + "scopes", + "chunkIndex", + "content", + } + + class properties: + chunkIndex = schemas.Int32Schema + content = schemas.StrSchema + filename = schemas.StrSchema + + + class pageNumbers( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.Int32Schema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, decimal.Decimal, int, ]], typing.List[typing.Union[MetaOapg.items, decimal.Decimal, int, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'pageNumbers': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class scopes( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'scopes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + score = schemas.Float32Schema + totalChunks = schemas.Int32Schema + title = schemas.StrSchema + workspaceId = schemas.StrSchema + __annotations__ = { + "chunkIndex": chunkIndex, + "content": content, + "filename": filename, + "pageNumbers": pageNumbers, + "scopes": scopes, + "score": score, + "totalChunks": totalChunks, + "title": title, + "workspaceId": workspaceId, + } + + score: MetaOapg.properties.score + filename: MetaOapg.properties.filename + pageNumbers: MetaOapg.properties.pageNumbers + totalChunks: MetaOapg.properties.totalChunks + scopes: MetaOapg.properties.scopes + chunkIndex: MetaOapg.properties.chunkIndex + content: MetaOapg.properties.content + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["chunkIndex"]) -> MetaOapg.properties.chunkIndex: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filename"]) -> MetaOapg.properties.filename: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["pageNumbers"]) -> MetaOapg.properties.pageNumbers: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["scopes"]) -> MetaOapg.properties.scopes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["score"]) -> MetaOapg.properties.score: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["totalChunks"]) -> MetaOapg.properties.totalChunks: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workspaceId"]) -> MetaOapg.properties.workspaceId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["chunkIndex", "content", "filename", "pageNumbers", "scopes", "score", "totalChunks", "title", "workspaceId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["chunkIndex"]) -> MetaOapg.properties.chunkIndex: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filename"]) -> MetaOapg.properties.filename: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["pageNumbers"]) -> MetaOapg.properties.pageNumbers: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["scopes"]) -> MetaOapg.properties.scopes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["score"]) -> MetaOapg.properties.score: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["totalChunks"]) -> MetaOapg.properties.totalChunks: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workspaceId"]) -> typing.Union[MetaOapg.properties.workspaceId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["chunkIndex", "content", "filename", "pageNumbers", "scopes", "score", "totalChunks", "title", "workspaceId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + score: typing.Union[MetaOapg.properties.score, decimal.Decimal, int, float, ], + filename: typing.Union[MetaOapg.properties.filename, str, ], + pageNumbers: typing.Union[MetaOapg.properties.pageNumbers, list, tuple, ], + totalChunks: typing.Union[MetaOapg.properties.totalChunks, decimal.Decimal, int, ], + scopes: typing.Union[MetaOapg.properties.scopes, list, tuple, ], + chunkIndex: typing.Union[MetaOapg.properties.chunkIndex, decimal.Decimal, int, ], + content: typing.Union[MetaOapg.properties.content, str, ], + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + workspaceId: typing.Union[MetaOapg.properties.workspaceId, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'KnowledgeSearchResultDto': + return super().__new__( + cls, + *_args, + score=score, + filename=filename, + pageNumbers=pageNumbers, + totalChunks=totalChunks, + scopes=scopes, + chunkIndex=chunkIndex, + content=content, + title=title, + workspaceId=workspaceId, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/list_knowledge_documents_response_dto.py b/gooddata-api-client/gooddata_api_client/model/list_knowledge_documents_response_dto.py new file mode 100644 index 000000000..9826850d1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/list_knowledge_documents_response_dto.py @@ -0,0 +1,284 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.knowledge_document_metadata_dto import KnowledgeDocumentMetadataDto + globals()['KnowledgeDocumentMetadataDto'] = KnowledgeDocumentMetadataDto + + +class ListKnowledgeDocumentsResponseDto(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'documents': ([KnowledgeDocumentMetadataDto],), # noqa: E501 + 'next_page_token': (str,), # noqa: E501 + 'total_count': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'documents': 'documents', # noqa: E501 + 'next_page_token': 'nextPageToken', # noqa: E501 + 'total_count': 'totalCount', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, documents, *args, **kwargs): # noqa: E501 + """ListKnowledgeDocumentsResponseDto - a model defined in OpenAPI + + Args: + documents ([KnowledgeDocumentMetadataDto]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + next_page_token (str): [optional] # noqa: E501 + total_count (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.documents = documents + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, documents, *args, **kwargs): # noqa: E501 + """ListKnowledgeDocumentsResponseDto - a model defined in OpenAPI + + Args: + documents ([KnowledgeDocumentMetadataDto]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + next_page_token (str): [optional] # noqa: E501 + total_count (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.documents = documents + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/list_knowledge_documents_response_dto.pyi b/gooddata-api-client/gooddata_api_client/model/list_knowledge_documents_response_dto.pyi new file mode 100644 index 000000000..a41116432 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/list_knowledge_documents_response_dto.pyi @@ -0,0 +1,131 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ListKnowledgeDocumentsResponseDto( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "documents", + } + + class properties: + + + class documents( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['KnowledgeDocumentMetadataDto']: + return KnowledgeDocumentMetadataDto + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['KnowledgeDocumentMetadataDto'], typing.List['KnowledgeDocumentMetadataDto']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'documents': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'KnowledgeDocumentMetadataDto': + return super().__getitem__(i) + nextPageToken = schemas.StrSchema + totalCount = schemas.Int32Schema + __annotations__ = { + "documents": documents, + "nextPageToken": nextPageToken, + "totalCount": totalCount, + } + + documents: MetaOapg.properties.documents + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["documents"]) -> MetaOapg.properties.documents: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["nextPageToken"]) -> MetaOapg.properties.nextPageToken: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["totalCount"]) -> MetaOapg.properties.totalCount: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["documents", "nextPageToken", "totalCount", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["documents"]) -> MetaOapg.properties.documents: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["nextPageToken"]) -> typing.Union[MetaOapg.properties.nextPageToken, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["totalCount"]) -> typing.Union[MetaOapg.properties.totalCount, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["documents", "nextPageToken", "totalCount", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + documents: typing.Union[MetaOapg.properties.documents, list, tuple, ], + nextPageToken: typing.Union[MetaOapg.properties.nextPageToken, str, schemas.Unset] = schemas.unset, + totalCount: typing.Union[MetaOapg.properties.totalCount, decimal.Decimal, int, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ListKnowledgeDocumentsResponseDto': + return super().__new__( + cls, + *_args, + documents=documents, + nextPageToken=nextPageToken, + totalCount=totalCount, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.knowledge_document_metadata_dto import KnowledgeDocumentMetadataDto diff --git a/gooddata-api-client/gooddata_api_client/model/llm_model.py b/gooddata-api-client/gooddata_api_client/model/llm_model.py new file mode 100644 index 000000000..575dd8d68 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/llm_model.py @@ -0,0 +1,288 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class LlmModel(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('family',): { + 'OPENAI': "OPENAI", + 'ANTHROPIC': "ANTHROPIC", + 'META': "META", + 'MISTRAL': "MISTRAL", + 'AMAZON': "AMAZON", + 'GOOGLE': "GOOGLE", + 'COHERE': "COHERE", + }, + } + + validations = { + ('id',): { + '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 { + 'family': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'family': 'family', # noqa: E501 + 'id': 'id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, family, id, *args, **kwargs): # noqa: E501 + """LlmModel - a model defined in OpenAPI + + Args: + family (str): Family of LLM models. + id (str): Unique identifier of the model (e.g., gpt-5.3, claude-4.6). + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.family = family + self.id = 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, family, id, *args, **kwargs): # noqa: E501 + """LlmModel - a model defined in OpenAPI + + Args: + family (str): Family of LLM models. + id (str): Unique identifier of the model (e.g., gpt-5.3, claude-4.6). + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.family = family + self.id = 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/llm_model.pyi b/gooddata-api-client/gooddata_api_client/model/llm_model.pyi new file mode 100644 index 000000000..2d626c027 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/llm_model.pyi @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class LlmModel( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + LLM Model configuration (id, family) within a provider. + """ + + + class MetaOapg: + required = { + "id", + "family", + } + + class properties: + + + class family( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def OPENAI(cls): + return cls("OPENAI") + + @schemas.classproperty + def ANTHROPIC(cls): + return cls("ANTHROPIC") + + @schemas.classproperty + def META(cls): + return cls("META") + + @schemas.classproperty + def MISTRAL(cls): + return cls("MISTRAL") + + @schemas.classproperty + def AMAZON(cls): + return cls("AMAZON") + + @schemas.classproperty + def GOOGLE(cls): + return cls("GOOGLE") + + @schemas.classproperty + def COHERE(cls): + return cls("COHERE") + + + class id( + schemas.StrSchema + ): + pass + __annotations__ = { + "family": family, + "id": id, + } + + id: MetaOapg.properties.id + family: MetaOapg.properties.family + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["family"]) -> MetaOapg.properties.family: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["family", "id", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["family"]) -> MetaOapg.properties.family: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["family", "id", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + family: typing.Union[MetaOapg.properties.family, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'LlmModel': + return super().__new__( + cls, + *_args, + id=id, + family=family, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/llm_provider_auth.py b/gooddata-api-client/gooddata_api_client/model/llm_provider_auth.py new file mode 100644 index 000000000..a25d2c414 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/llm_provider_auth.py @@ -0,0 +1,270 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class LlmProviderAuth(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 + """LlmProviderAuth - 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 + """LlmProviderAuth - 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/llm_provider_auth.pyi b/gooddata-api-client/gooddata_api_client/model/llm_provider_auth.pyi new file mode 100644 index 000000000..526023c1f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/llm_provider_auth.pyi @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class LlmProviderAuth( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "type", + } + + class properties: + type = schemas.StrSchema + __annotations__ = { + "type": type, + } + + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'LlmProviderAuth': + return super().__new__( + cls, + *_args, + type=type, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/llm_provider_config.py b/gooddata-api-client/gooddata_api_client/model/llm_provider_config.py new file mode 100644 index 000000000..e18d277f1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/llm_provider_config.py @@ -0,0 +1,363 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.aws_bedrock_provider_config import AwsBedrockProviderConfig + from gooddata_api_client.model.azure_foundry_provider_config import AzureFoundryProviderConfig + from gooddata_api_client.model.open_ai_provider_auth import OpenAiProviderAuth + from gooddata_api_client.model.open_ai_provider_config import OpenAIProviderConfig + globals()['AwsBedrockProviderConfig'] = AwsBedrockProviderConfig + globals()['AzureFoundryProviderConfig'] = AzureFoundryProviderConfig + globals()['OpenAIProviderConfig'] = OpenAIProviderConfig + globals()['OpenAiProviderAuth'] = OpenAiProviderAuth + + +class LlmProviderConfig(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',): { + 'OPENAI': "OPENAI", + }, + } + + validations = { + ('base_url',): { + 'max_length': 255, + }, + ('organization',): { + 'max_length': 255, + }, + ('region',): { + 'max_length': 255, + }, + ('endpoint',): { + '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 { + 'base_url': (str, none_type,), # noqa: E501 + 'organization': (str, none_type,), # noqa: E501 + 'auth': (OpenAiProviderAuth,), # noqa: E501 + 'region': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'endpoint': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'base_url': 'baseUrl', # noqa: E501 + 'organization': 'organization', # noqa: E501 + 'auth': 'auth', # noqa: E501 + 'region': 'region', # noqa: E501 + 'type': 'type', # noqa: E501 + 'endpoint': 'endpoint', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LlmProviderConfig - 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,) + base_url (str, none_type): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com" # noqa: E501 + organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 + auth (OpenAiProviderAuth): [optional] # noqa: E501 + region (str): AWS region for Bedrock.. [optional] # noqa: E501 + type (str): Provider type.. [optional] if omitted the server will use the default value of "OPENAI" # noqa: E501 + endpoint (str): Azure AI inference endpoint URL.. [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 + """LlmProviderConfig - 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,) + base_url (str, none_type): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com" # noqa: E501 + organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 + auth (OpenAiProviderAuth): [optional] # noqa: E501 + region (str): AWS region for Bedrock.. [optional] # noqa: E501 + type (str): Provider type.. [optional] if omitted the server will use the default value of "OPENAI" # noqa: E501 + endpoint (str): Azure AI inference endpoint URL.. [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': [ + AwsBedrockProviderConfig, + AzureFoundryProviderConfig, + OpenAIProviderConfig, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/llm_provider_config.pyi b/gooddata-api-client/gooddata_api_client/model/llm_provider_config.pyi new file mode 100644 index 000000000..0e87f6419 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/llm_provider_config.pyi @@ -0,0 +1,73 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class LlmProviderConfig( + schemas.ComposedSchema, +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Provider configuration to test. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AwsBedrockProviderConfig, + AzureFoundryProviderConfig, + OpenAIProviderConfig, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'LlmProviderConfig': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aws_bedrock_provider_config import AwsBedrockProviderConfig +from gooddata_api_client.model.azure_foundry_provider_config import AzureFoundryProviderConfig +from gooddata_api_client.model.open_ai_provider_config import OpenAIProviderConfig diff --git a/gooddata-api-client/gooddata_api_client/model/local_identifier.pyi b/gooddata-api-client/gooddata_api_client/model/local_identifier.pyi new file mode 100644 index 000000000..8aa3ecc24 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/local_identifier.pyi @@ -0,0 +1,148 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class LocalIdentifier( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "localIdentifier", + } + + class properties: + localIdentifier = schemas.StrSchema + + + class format( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'format': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class title( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'title': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + __annotations__ = { + "localIdentifier": localIdentifier, + "format": format, + "title": title, + } + + localIdentifier: MetaOapg.properties.localIdentifier + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["localIdentifier", "format", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["format"]) -> typing.Union[MetaOapg.properties.format, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["localIdentifier", "format", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + localIdentifier: typing.Union[MetaOapg.properties.localIdentifier, str, ], + format: typing.Union[MetaOapg.properties.format, None, str, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, None, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'LocalIdentifier': + return super().__new__( + cls, + *_args, + localIdentifier=localIdentifier, + format=format, + title=title, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/locale_request.pyi b/gooddata-api-client/gooddata_api_client/model/locale_request.pyi new file mode 100644 index 000000000..967b71086 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/locale_request.pyi @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class LocaleRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "locale", + } + + class properties: + locale = schemas.StrSchema + __annotations__ = { + "locale": locale, + } + + locale: MetaOapg.properties.locale + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["locale"]) -> MetaOapg.properties.locale: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["locale", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["locale"]) -> MetaOapg.properties.locale: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["locale", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + locale: typing.Union[MetaOapg.properties.locale, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'LocaleRequest': + return super().__new__( + cls, + *_args, + locale=locale, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/match_attribute_filter.pyi b/gooddata-api-client/gooddata_api_client/model/match_attribute_filter.pyi new file mode 100644 index 000000000..6a7d58c4c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/match_attribute_filter.pyi @@ -0,0 +1,226 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class MatchAttributeFilter( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Filter via label with given match type and literal value. + """ + + + class MetaOapg: + required = { + "matchAttributeFilter", + } + + class properties: + + + class matchAttributeFilter( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "matchType", + "label", + "literal", + } + + class properties: + applyOnResult = schemas.BoolSchema + caseSensitive = schemas.BoolSchema + + @staticmethod + def label() -> typing.Type['AfmIdentifier']: + return AfmIdentifier + literal = schemas.StrSchema + localIdentifier = schemas.StrSchema + + + class matchType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def STARTS_WITH(cls): + return cls("STARTS_WITH") + + @schemas.classproperty + def ENDS_WITH(cls): + return cls("ENDS_WITH") + + @schemas.classproperty + def CONTAINS(cls): + return cls("CONTAINS") + negate = schemas.BoolSchema + __annotations__ = { + "applyOnResult": applyOnResult, + "caseSensitive": caseSensitive, + "label": label, + "literal": literal, + "localIdentifier": localIdentifier, + "matchType": matchType, + "negate": negate, + } + + matchType: MetaOapg.properties.matchType + label: 'AfmIdentifier' + literal: MetaOapg.properties.literal + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["applyOnResult"]) -> MetaOapg.properties.applyOnResult: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["caseSensitive"]) -> MetaOapg.properties.caseSensitive: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["label"]) -> 'AfmIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["literal"]) -> MetaOapg.properties.literal: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["matchType"]) -> MetaOapg.properties.matchType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["negate"]) -> MetaOapg.properties.negate: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "caseSensitive", "label", "literal", "localIdentifier", "matchType", "negate", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["applyOnResult"]) -> typing.Union[MetaOapg.properties.applyOnResult, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["caseSensitive"]) -> typing.Union[MetaOapg.properties.caseSensitive, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["label"]) -> 'AfmIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["literal"]) -> MetaOapg.properties.literal: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["localIdentifier"]) -> typing.Union[MetaOapg.properties.localIdentifier, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["matchType"]) -> MetaOapg.properties.matchType: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["negate"]) -> typing.Union[MetaOapg.properties.negate, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["applyOnResult", "caseSensitive", "label", "literal", "localIdentifier", "matchType", "negate", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + matchType: typing.Union[MetaOapg.properties.matchType, str, ], + label: 'AfmIdentifier', + literal: typing.Union[MetaOapg.properties.literal, str, ], + applyOnResult: typing.Union[MetaOapg.properties.applyOnResult, bool, schemas.Unset] = schemas.unset, + caseSensitive: typing.Union[MetaOapg.properties.caseSensitive, bool, schemas.Unset] = schemas.unset, + localIdentifier: typing.Union[MetaOapg.properties.localIdentifier, str, schemas.Unset] = schemas.unset, + negate: typing.Union[MetaOapg.properties.negate, bool, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'matchAttributeFilter': + return super().__new__( + cls, + *_args, + matchType=matchType, + label=label, + literal=literal, + applyOnResult=applyOnResult, + caseSensitive=caseSensitive, + localIdentifier=localIdentifier, + negate=negate, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "matchAttributeFilter": matchAttributeFilter, + } + + matchAttributeFilter: MetaOapg.properties.matchAttributeFilter + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["matchAttributeFilter"]) -> MetaOapg.properties.matchAttributeFilter: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["matchAttributeFilter", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["matchAttributeFilter"]) -> MetaOapg.properties.matchAttributeFilter: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["matchAttributeFilter", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + matchAttributeFilter: typing.Union[MetaOapg.properties.matchAttributeFilter, dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'MatchAttributeFilter': + return super().__new__( + cls, + *_args, + matchAttributeFilter=matchAttributeFilter, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.afm_identifier import AfmIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/measure_header.pyi b/gooddata-api-client/gooddata_api_client/model/measure_header.pyi new file mode 100644 index 000000000..31cd15051 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/measure_header.pyi @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class MeasureHeader( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "localIdentifier", + } + + class properties: + localIdentifier = schemas.StrSchema + format = schemas.StrSchema + name = schemas.StrSchema + __annotations__ = { + "localIdentifier": localIdentifier, + "format": format, + "name": name, + } + + localIdentifier: MetaOapg.properties.localIdentifier + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["localIdentifier", "format", "name", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["format"]) -> typing.Union[MetaOapg.properties.format, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["localIdentifier", "format", "name", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + localIdentifier: typing.Union[MetaOapg.properties.localIdentifier, str, ], + format: typing.Union[MetaOapg.properties.format, str, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'MeasureHeader': + return super().__new__( + cls, + *_args, + localIdentifier=localIdentifier, + format=format, + name=name, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/measure_value_condition.pyi b/gooddata-api-client/gooddata_api_client/model/measure_value_condition.pyi new file mode 100644 index 000000000..8447755ab --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/measure_value_condition.pyi @@ -0,0 +1,72 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class MeasureValueCondition( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + A condition for filtering by measure value. Can be either a comparison or a range condition. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + ComparisonCondition, + RangeCondition, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'MeasureValueCondition': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.comparison_condition import ComparisonCondition +from gooddata_api_client.model.range_condition import RangeCondition diff --git a/gooddata-api-client/gooddata_api_client/model/memory_item_created_by_users.pyi b/gooddata-api-client/gooddata_api_client/model/memory_item_created_by_users.pyi new file mode 100644 index 000000000..e9c04ec3f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/memory_item_created_by_users.pyi @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class MemoryItemCreatedByUsers( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "reasoning", + "users", + } + + class properties: + reasoning = schemas.StrSchema + + + class users( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['MemoryItemUser']: + return MemoryItemUser + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['MemoryItemUser'], typing.List['MemoryItemUser']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'users': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'MemoryItemUser': + return super().__getitem__(i) + __annotations__ = { + "reasoning": reasoning, + "users": users, + } + + reasoning: MetaOapg.properties.reasoning + users: MetaOapg.properties.users + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["reasoning"]) -> MetaOapg.properties.reasoning: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["reasoning", "users", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["reasoning"]) -> MetaOapg.properties.reasoning: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["reasoning", "users", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + reasoning: typing.Union[MetaOapg.properties.reasoning, str, ], + users: typing.Union[MetaOapg.properties.users, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'MemoryItemCreatedByUsers': + return super().__new__( + cls, + *_args, + reasoning=reasoning, + users=users, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.memory_item_user import MemoryItemUser diff --git a/gooddata-api-client/gooddata_api_client/model/memory_item_user.pyi b/gooddata-api-client/gooddata_api_client/model/memory_item_user.pyi new file mode 100644 index 000000000..363bfde1f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/memory_item_user.pyi @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class MemoryItemUser( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Users who created memory item + """ + + + class MetaOapg: + required = { + "firstname", + "userId", + "lastname", + } + + class properties: + firstname = schemas.StrSchema + lastname = schemas.StrSchema + userId = schemas.StrSchema + __annotations__ = { + "firstname": firstname, + "lastname": lastname, + "userId": userId, + } + + firstname: MetaOapg.properties.firstname + userId: MetaOapg.properties.userId + lastname: MetaOapg.properties.lastname + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["firstname"]) -> MetaOapg.properties.firstname: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["lastname"]) -> MetaOapg.properties.lastname: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["userId"]) -> MetaOapg.properties.userId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["firstname", "lastname", "userId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["firstname"]) -> MetaOapg.properties.firstname: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["lastname"]) -> MetaOapg.properties.lastname: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["userId"]) -> MetaOapg.properties.userId: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["firstname", "lastname", "userId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + firstname: typing.Union[MetaOapg.properties.firstname, str, ], + userId: typing.Union[MetaOapg.properties.userId, str, ], + lastname: typing.Union[MetaOapg.properties.lastname, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'MemoryItemUser': + return super().__new__( + cls, + *_args, + firstname=firstname, + userId=userId, + lastname=lastname, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/metric.pyi b/gooddata-api-client/gooddata_api_client/model/metric.pyi new file mode 100644 index 000000000..991e5a7fa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/metric.pyi @@ -0,0 +1,166 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Metric( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + List of metrics to be used in the new visualization + """ + + + class MetaOapg: + required = { + "id", + "title", + "type", + } + + class properties: + id = schemas.StrSchema + title = schemas.StrSchema + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def FACT(cls): + return cls("fact") + + @schemas.classproperty + def ATTRIBUTE(cls): + return cls("attribute") + + + class aggFunction( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def COUNT(cls): + return cls("COUNT") + + @schemas.classproperty + def SUM(cls): + return cls("SUM") + + @schemas.classproperty + def MIN(cls): + return cls("MIN") + + @schemas.classproperty + def MAX(cls): + return cls("MAX") + + @schemas.classproperty + def AVG(cls): + return cls("AVG") + + @schemas.classproperty + def MEDIAN(cls): + return cls("MEDIAN") + __annotations__ = { + "id": id, + "title": title, + "type": type, + "aggFunction": aggFunction, + } + + id: MetaOapg.properties.id + title: MetaOapg.properties.title + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["aggFunction"]) -> MetaOapg.properties.aggFunction: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "title", "type", "aggFunction", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["aggFunction"]) -> typing.Union[MetaOapg.properties.aggFunction, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "title", "type", "aggFunction", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + title: typing.Union[MetaOapg.properties.title, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + aggFunction: typing.Union[MetaOapg.properties.aggFunction, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Metric': + return super().__new__( + cls, + *_args, + id=id, + title=title, + type=type, + aggFunction=aggFunction, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/metric_definition_override.py b/gooddata-api-client/gooddata_api_client/model/metric_definition_override.py new file mode 100644 index 000000000..22a0ccbae --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/metric_definition_override.py @@ -0,0 +1,284 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.afm_object_identifier_core import AfmObjectIdentifierCore + from gooddata_api_client.model.inline_measure_definition import InlineMeasureDefinition + globals()['AfmObjectIdentifierCore'] = AfmObjectIdentifierCore + globals()['InlineMeasureDefinition'] = InlineMeasureDefinition + + +class MetricDefinitionOverride(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'definition': (InlineMeasureDefinition,), # noqa: E501 + 'item': (AfmObjectIdentifierCore,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'definition': 'definition', # noqa: E501 + 'item': 'item', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, definition, item, *args, **kwargs): # noqa: E501 + """MetricDefinitionOverride - a model defined in OpenAPI + + Args: + definition (InlineMeasureDefinition): + item (AfmObjectIdentifierCore): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.definition = definition + self.item = item + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, definition, item, *args, **kwargs): # noqa: E501 + """MetricDefinitionOverride - a model defined in OpenAPI + + Args: + definition (InlineMeasureDefinition): + item (AfmObjectIdentifierCore): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.definition = definition + self.item = item + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-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_definition_override.pyi b/gooddata-api-client/gooddata_api_client/model/metric_definition_override.pyi new file mode 100644 index 000000000..ee4fdccbb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/metric_definition_override.pyi @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class MetricDefinitionOverride( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + (EXPERIMENTAL) Override for a catalog metric definition. + """ + + + class MetaOapg: + required = { + "item", + "definition", + } + + class properties: + + @staticmethod + def definition() -> typing.Type['InlineMeasureDefinition']: + return InlineMeasureDefinition + + @staticmethod + def item() -> typing.Type['AfmObjectIdentifierCore']: + return AfmObjectIdentifierCore + __annotations__ = { + "definition": definition, + "item": item, + } + + item: 'AfmObjectIdentifierCore' + definition: 'InlineMeasureDefinition' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["definition"]) -> 'InlineMeasureDefinition': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["item"]) -> 'AfmObjectIdentifierCore': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["definition", "item", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["definition"]) -> 'InlineMeasureDefinition': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["item"]) -> 'AfmObjectIdentifierCore': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["definition", "item", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + item: 'AfmObjectIdentifierCore', + definition: 'InlineMeasureDefinition', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'MetricDefinitionOverride': + return super().__new__( + cls, + *_args, + item=item, + definition=definition, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.afm_object_identifier_core import AfmObjectIdentifierCore +from gooddata_api_client.model.inline_measure_definition import InlineMeasureDefinition diff --git a/gooddata-api-client/gooddata_api_client/model/metric_record.pyi b/gooddata-api-client/gooddata_api_client/model/metric_record.pyi new file mode 100644 index 000000000..f5089f885 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/metric_record.pyi @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class MetricRecord( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "value", + } + + class properties: + value = schemas.Float64Schema + formattedValue = schemas.StrSchema + __annotations__ = { + "value": value, + "formattedValue": formattedValue, + } + + value: MetaOapg.properties.value + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["formattedValue"]) -> MetaOapg.properties.formattedValue: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["value", "formattedValue", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["formattedValue"]) -> typing.Union[MetaOapg.properties.formattedValue, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["value", "formattedValue", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + value: typing.Union[MetaOapg.properties.value, decimal.Decimal, int, float, ], + formattedValue: typing.Union[MetaOapg.properties.formattedValue, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'MetricRecord': + return super().__new__( + cls, + *_args, + value=value, + formattedValue=formattedValue, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/metric_value_change.pyi b/gooddata-api-client/gooddata_api_client/model/metric_value_change.pyi new file mode 100644 index 000000000..806f3257c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/metric_value_change.pyi @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class MetricValueChange( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Individual change analysis data item + """ + + + class MetaOapg: + required = { + "overallMetricValueInReferencePeriod", + "metricValueDeltaAbs", + "isSignificantChange", + "attributeValue", + "attributeValuesChangeStd", + "attributeName", + "metricValueInAnalyzedPeriod", + "metricValueDelta", + "metricValueInReferencePeriod", + "attributeValuesChangeMean", + "overallMetricValueInAnalyzedPeriod", + } + + class properties: + attributeName = schemas.StrSchema + attributeValue = schemas.StrSchema + attributeValuesChangeMean = schemas.Float64Schema + attributeValuesChangeStd = schemas.Float64Schema + isSignificantChange = schemas.BoolSchema + metricValueDelta = schemas.Float64Schema + metricValueDeltaAbs = schemas.Float64Schema + metricValueInAnalyzedPeriod = schemas.Float64Schema + metricValueInReferencePeriod = schemas.Float64Schema + overallMetricValueInAnalyzedPeriod = schemas.Float64Schema + overallMetricValueInReferencePeriod = schemas.Float64Schema + __annotations__ = { + "attributeName": attributeName, + "attributeValue": attributeValue, + "attributeValuesChangeMean": attributeValuesChangeMean, + "attributeValuesChangeStd": attributeValuesChangeStd, + "isSignificantChange": isSignificantChange, + "metricValueDelta": metricValueDelta, + "metricValueDeltaAbs": metricValueDeltaAbs, + "metricValueInAnalyzedPeriod": metricValueInAnalyzedPeriod, + "metricValueInReferencePeriod": metricValueInReferencePeriod, + "overallMetricValueInAnalyzedPeriod": overallMetricValueInAnalyzedPeriod, + "overallMetricValueInReferencePeriod": overallMetricValueInReferencePeriod, + } + + overallMetricValueInReferencePeriod: MetaOapg.properties.overallMetricValueInReferencePeriod + metricValueDeltaAbs: MetaOapg.properties.metricValueDeltaAbs + isSignificantChange: MetaOapg.properties.isSignificantChange + attributeValue: MetaOapg.properties.attributeValue + attributeValuesChangeStd: MetaOapg.properties.attributeValuesChangeStd + attributeName: MetaOapg.properties.attributeName + metricValueInAnalyzedPeriod: MetaOapg.properties.metricValueInAnalyzedPeriod + metricValueDelta: MetaOapg.properties.metricValueDelta + metricValueInReferencePeriod: MetaOapg.properties.metricValueInReferencePeriod + attributeValuesChangeMean: MetaOapg.properties.attributeValuesChangeMean + overallMetricValueInAnalyzedPeriod: MetaOapg.properties.overallMetricValueInAnalyzedPeriod + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributeName"]) -> MetaOapg.properties.attributeName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributeValue"]) -> MetaOapg.properties.attributeValue: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributeValuesChangeMean"]) -> MetaOapg.properties.attributeValuesChangeMean: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributeValuesChangeStd"]) -> MetaOapg.properties.attributeValuesChangeStd: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isSignificantChange"]) -> MetaOapg.properties.isSignificantChange: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metricValueDelta"]) -> MetaOapg.properties.metricValueDelta: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metricValueDeltaAbs"]) -> MetaOapg.properties.metricValueDeltaAbs: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metricValueInAnalyzedPeriod"]) -> MetaOapg.properties.metricValueInAnalyzedPeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metricValueInReferencePeriod"]) -> MetaOapg.properties.metricValueInReferencePeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["overallMetricValueInAnalyzedPeriod"]) -> MetaOapg.properties.overallMetricValueInAnalyzedPeriod: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["overallMetricValueInReferencePeriod"]) -> MetaOapg.properties.overallMetricValueInReferencePeriod: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributeName", "attributeValue", "attributeValuesChangeMean", "attributeValuesChangeStd", "isSignificantChange", "metricValueDelta", "metricValueDeltaAbs", "metricValueInAnalyzedPeriod", "metricValueInReferencePeriod", "overallMetricValueInAnalyzedPeriod", "overallMetricValueInReferencePeriod", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributeName"]) -> MetaOapg.properties.attributeName: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributeValue"]) -> MetaOapg.properties.attributeValue: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributeValuesChangeMean"]) -> MetaOapg.properties.attributeValuesChangeMean: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributeValuesChangeStd"]) -> MetaOapg.properties.attributeValuesChangeStd: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isSignificantChange"]) -> MetaOapg.properties.isSignificantChange: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metricValueDelta"]) -> MetaOapg.properties.metricValueDelta: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metricValueDeltaAbs"]) -> MetaOapg.properties.metricValueDeltaAbs: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metricValueInAnalyzedPeriod"]) -> MetaOapg.properties.metricValueInAnalyzedPeriod: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metricValueInReferencePeriod"]) -> MetaOapg.properties.metricValueInReferencePeriod: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["overallMetricValueInAnalyzedPeriod"]) -> MetaOapg.properties.overallMetricValueInAnalyzedPeriod: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["overallMetricValueInReferencePeriod"]) -> MetaOapg.properties.overallMetricValueInReferencePeriod: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributeName", "attributeValue", "attributeValuesChangeMean", "attributeValuesChangeStd", "isSignificantChange", "metricValueDelta", "metricValueDeltaAbs", "metricValueInAnalyzedPeriod", "metricValueInReferencePeriod", "overallMetricValueInAnalyzedPeriod", "overallMetricValueInReferencePeriod", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + overallMetricValueInReferencePeriod: typing.Union[MetaOapg.properties.overallMetricValueInReferencePeriod, decimal.Decimal, int, float, ], + metricValueDeltaAbs: typing.Union[MetaOapg.properties.metricValueDeltaAbs, decimal.Decimal, int, float, ], + isSignificantChange: typing.Union[MetaOapg.properties.isSignificantChange, bool, ], + attributeValue: typing.Union[MetaOapg.properties.attributeValue, str, ], + attributeValuesChangeStd: typing.Union[MetaOapg.properties.attributeValuesChangeStd, decimal.Decimal, int, float, ], + attributeName: typing.Union[MetaOapg.properties.attributeName, str, ], + metricValueInAnalyzedPeriod: typing.Union[MetaOapg.properties.metricValueInAnalyzedPeriod, decimal.Decimal, int, float, ], + metricValueDelta: typing.Union[MetaOapg.properties.metricValueDelta, decimal.Decimal, int, float, ], + metricValueInReferencePeriod: typing.Union[MetaOapg.properties.metricValueInReferencePeriod, decimal.Decimal, int, float, ], + attributeValuesChangeMean: typing.Union[MetaOapg.properties.attributeValuesChangeMean, decimal.Decimal, int, float, ], + overallMetricValueInAnalyzedPeriod: typing.Union[MetaOapg.properties.overallMetricValueInAnalyzedPeriod, decimal.Decimal, int, float, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'MetricValueChange': + return super().__new__( + cls, + *_args, + overallMetricValueInReferencePeriod=overallMetricValueInReferencePeriod, + metricValueDeltaAbs=metricValueDeltaAbs, + isSignificantChange=isSignificantChange, + attributeValue=attributeValue, + attributeValuesChangeStd=attributeValuesChangeStd, + attributeName=attributeName, + metricValueInAnalyzedPeriod=metricValueInAnalyzedPeriod, + metricValueDelta=metricValueDelta, + metricValueInReferencePeriod=metricValueInReferencePeriod, + attributeValuesChangeMean=attributeValuesChangeMean, + overallMetricValueInAnalyzedPeriod=overallMetricValueInAnalyzedPeriod, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/model_test_result.py b/gooddata-api-client/gooddata_api_client/model/model_test_result.py new file mode 100644 index 000000000..608c9a56c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/model_test_result.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 ModelTestResult(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 + 'model_id': (str,), # noqa: E501 + 'successful': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'message': 'message', # noqa: E501 + 'model_id': 'modelId', # noqa: E501 + 'successful': 'successful', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, message, model_id, successful, *args, **kwargs): # noqa: E501 + """ModelTestResult - a model defined in OpenAPI + + Args: + message (str): Message about the model test result. + model_id (str): The model ID that was tested. + successful (bool): Whether the model test was successful. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.model_id = model_id + self.successful = successful + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = 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, model_id, successful, *args, **kwargs): # noqa: E501 + """ModelTestResult - a model defined in OpenAPI + + Args: + message (str): Message about the model test result. + model_id (str): The model ID that was tested. + successful (bool): Whether the model test was successful. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.model_id = model_id + self.successful = successful + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/model_test_result.pyi b/gooddata-api-client/gooddata_api_client/model/model_test_result.pyi new file mode 100644 index 000000000..27be06210 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/model_test_result.pyi @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ModelTestResult( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Per-model test results. + """ + + + class MetaOapg: + required = { + "modelId", + "message", + "successful", + } + + class properties: + message = schemas.StrSchema + modelId = schemas.StrSchema + successful = schemas.BoolSchema + __annotations__ = { + "message": message, + "modelId": modelId, + "successful": successful, + } + + modelId: MetaOapg.properties.modelId + message: MetaOapg.properties.message + successful: MetaOapg.properties.successful + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["message"]) -> MetaOapg.properties.message: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modelId"]) -> MetaOapg.properties.modelId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["successful"]) -> MetaOapg.properties.successful: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["message", "modelId", "successful", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["message"]) -> MetaOapg.properties.message: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modelId"]) -> MetaOapg.properties.modelId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["successful"]) -> MetaOapg.properties.successful: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["message", "modelId", "successful", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + modelId: typing.Union[MetaOapg.properties.modelId, str, ], + message: typing.Union[MetaOapg.properties.message, str, ], + successful: typing.Union[MetaOapg.properties.successful, bool, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ModelTestResult': + return super().__new__( + cls, + *_args, + modelId=modelId, + message=message, + successful=successful, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/note.pyi b/gooddata-api-client/gooddata_api_client/model/note.pyi new file mode 100644 index 000000000..5131987e4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/note.pyi @@ -0,0 +1,170 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Note( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + + class appliesTo( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SOURCE(cls): + return cls("SOURCE") + + @schemas.classproperty + def TARGET(cls): + return cls("TARGET") + category = schemas.StrSchema + content = schemas.StrSchema + id = schemas.StrSchema + + + class otherAttributes( + schemas.DictSchema + ): + + + class MetaOapg: + additional_properties = schemas.StrSchema + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, str, ], + ) -> 'otherAttributes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + priority = schemas.Int32Schema + __annotations__ = { + "appliesTo": appliesTo, + "category": category, + "content": content, + "id": id, + "otherAttributes": otherAttributes, + "priority": priority, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["appliesTo"]) -> MetaOapg.properties.appliesTo: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["category"]) -> MetaOapg.properties.category: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["otherAttributes"]) -> MetaOapg.properties.otherAttributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["priority"]) -> MetaOapg.properties.priority: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["appliesTo", "category", "content", "id", "otherAttributes", "priority", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["appliesTo"]) -> typing.Union[MetaOapg.properties.appliesTo, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["category"]) -> typing.Union[MetaOapg.properties.category, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union[MetaOapg.properties.content, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> typing.Union[MetaOapg.properties.id, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["otherAttributes"]) -> typing.Union[MetaOapg.properties.otherAttributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["priority"]) -> typing.Union[MetaOapg.properties.priority, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["appliesTo", "category", "content", "id", "otherAttributes", "priority", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + appliesTo: typing.Union[MetaOapg.properties.appliesTo, str, schemas.Unset] = schemas.unset, + category: typing.Union[MetaOapg.properties.category, str, schemas.Unset] = schemas.unset, + content: typing.Union[MetaOapg.properties.content, str, schemas.Unset] = schemas.unset, + id: typing.Union[MetaOapg.properties.id, str, schemas.Unset] = schemas.unset, + otherAttributes: typing.Union[MetaOapg.properties.otherAttributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + priority: typing.Union[MetaOapg.properties.priority, decimal.Decimal, int, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Note': + return super().__new__( + cls, + *_args, + appliesTo=appliesTo, + category=category, + content=content, + id=id, + otherAttributes=otherAttributes, + priority=priority, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/notes.pyi b/gooddata-api-client/gooddata_api_client/model/notes.pyi new file mode 100644 index 000000000..690df30fa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/notes.pyi @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Notes( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + + class note( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['Note']: + return Note + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['Note'], typing.List['Note']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'note': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'Note': + return super().__getitem__(i) + __annotations__ = { + "note": note, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["note"]) -> MetaOapg.properties.note: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["note", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["note"]) -> typing.Union[MetaOapg.properties.note, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["note", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + note: typing.Union[MetaOapg.properties.note, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Notes': + return super().__new__( + cls, + *_args, + note=note, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.note import Note diff --git a/gooddata-api-client/gooddata_api_client/model/notification.pyi b/gooddata-api-client/gooddata_api_client/model/notification.pyi new file mode 100644 index 000000000..45793510d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/notification.pyi @@ -0,0 +1,179 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Notification( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "createdAt", + "data", + "isRead", + "id", + } + + class properties: + createdAt = schemas.DateTimeSchema + + + class data( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AutomationNotification, + TestNotification, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'data': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + id = schemas.StrSchema + isRead = schemas.BoolSchema + automationId = schemas.StrSchema + workspaceId = schemas.StrSchema + __annotations__ = { + "createdAt": createdAt, + "data": data, + "id": id, + "isRead": isRead, + "automationId": automationId, + "workspaceId": workspaceId, + } + + createdAt: MetaOapg.properties.createdAt + data: MetaOapg.properties.data + isRead: MetaOapg.properties.isRead + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdAt"]) -> MetaOapg.properties.createdAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isRead"]) -> MetaOapg.properties.isRead: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["automationId"]) -> MetaOapg.properties.automationId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workspaceId"]) -> MetaOapg.properties.workspaceId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["createdAt", "data", "id", "isRead", "automationId", "workspaceId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdAt"]) -> MetaOapg.properties.createdAt: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isRead"]) -> MetaOapg.properties.isRead: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["automationId"]) -> typing.Union[MetaOapg.properties.automationId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workspaceId"]) -> typing.Union[MetaOapg.properties.workspaceId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["createdAt", "data", "id", "isRead", "automationId", "workspaceId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + createdAt: typing.Union[MetaOapg.properties.createdAt, str, datetime, ], + data: typing.Union[MetaOapg.properties.data, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + isRead: typing.Union[MetaOapg.properties.isRead, bool, ], + id: typing.Union[MetaOapg.properties.id, str, ], + automationId: typing.Union[MetaOapg.properties.automationId, str, schemas.Unset] = schemas.unset, + workspaceId: typing.Union[MetaOapg.properties.workspaceId, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Notification': + return super().__new__( + cls, + *_args, + createdAt=createdAt, + data=data, + isRead=isRead, + id=id, + automationId=automationId, + workspaceId=workspaceId, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.automation_notification import AutomationNotification +from gooddata_api_client.model.test_notification import TestNotification diff --git a/gooddata-api-client/gooddata_api_client/model/notification_channel_destination.py b/gooddata-api-client/gooddata_api_client/model/notification_channel_destination.py index 86ee1ed6b..29f5583e9 100644 --- a/gooddata-api-client/gooddata_api_client/model/notification_channel_destination.py +++ b/gooddata-api-client/gooddata_api_client/model/notification_channel_destination.py @@ -75,6 +75,10 @@ class NotificationChannelDestination(ModelComposed): } validations = { + ('has_secret_key',): { + }, + ('has_token',): { + }, ('secret_key',): { 'max_length': 10000, }, diff --git a/gooddata-api-client/gooddata_api_client/model/notification_channel_destination.pyi b/gooddata-api-client/gooddata_api_client/model/notification_channel_destination.pyi new file mode 100644 index 000000000..2ebf1449f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/notification_channel_destination.pyi @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class NotificationChannelDestination( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "type", + } + + class properties: + type = schemas.StrSchema + __annotations__ = { + "type": type, + } + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + Webhook, + Smtp, + DefaultSmtp, + InPlatform, + ] + + + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'NotificationChannelDestination': + return super().__new__( + cls, + *_args, + type=type, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.default_smtp import DefaultSmtp +from gooddata_api_client.model.in_platform import InPlatform +from gooddata_api_client.model.smtp import Smtp +from gooddata_api_client.model.webhook import Webhook diff --git a/gooddata-api-client/gooddata_api_client/model/notification_content.py b/gooddata-api-client/gooddata_api_client/model/notification_content.py index acf1a390d..db3a871b8 100644 --- a/gooddata-api-client/gooddata_api_client/model/notification_content.py +++ b/gooddata-api-client/gooddata_api_client/model/notification_content.py @@ -98,9 +98,7 @@ def discriminator(): lazy_import() val = { 'AUTOMATION': AutomationNotification, - 'AutomationNotification': AutomationNotification, 'TEST': TestNotification, - 'TestNotification': TestNotification, } if not val: return None diff --git a/gooddata-api-client/gooddata_api_client/model/notification_content.pyi b/gooddata-api-client/gooddata_api_client/model/notification_content.pyi new file mode 100644 index 000000000..553163898 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/notification_content.pyi @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class NotificationContent( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "type", + } + + @staticmethod + def discriminator(): + return { + 'type': { + 'AUTOMATION': AutomationNotification, + 'TEST': TestNotification, + } + } + + class properties: + type = schemas.StrSchema + __annotations__ = { + "type": type, + } + + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'NotificationContent': + return super().__new__( + cls, + *_args, + type=type, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.automation_notification import AutomationNotification +from gooddata_api_client.model.test_notification import TestNotification diff --git a/gooddata-api-client/gooddata_api_client/model/notification_filter.pyi b/gooddata-api-client/gooddata_api_client/model/notification_filter.pyi new file mode 100644 index 000000000..33d7423f1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/notification_filter.pyi @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class NotificationFilter( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "filter", + "title", + } + + class properties: + filter = schemas.StrSchema + title = schemas.StrSchema + __annotations__ = { + "filter": filter, + "title": title, + } + + filter: MetaOapg.properties.filter + title: MetaOapg.properties.title + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filter"]) -> MetaOapg.properties.filter: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["filter", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filter"]) -> MetaOapg.properties.filter: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["filter", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + filter: typing.Union[MetaOapg.properties.filter, str, ], + title: typing.Union[MetaOapg.properties.title, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'NotificationFilter': + return super().__new__( + cls, + *_args, + filter=filter, + title=title, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/notifications.pyi b/gooddata-api-client/gooddata_api_client/model/notifications.pyi new file mode 100644 index 000000000..55e7b3f56 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/notifications.pyi @@ -0,0 +1,127 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Notifications( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + "meta", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['Notification']: + return Notification + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['Notification'], typing.List['Notification']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'Notification': + return super().__getitem__(i) + + @staticmethod + def meta() -> typing.Type['NotificationsMeta']: + return NotificationsMeta + __annotations__ = { + "data": data, + "meta": meta, + } + + data: MetaOapg.properties.data + meta: 'NotificationsMeta' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["meta"]) -> 'NotificationsMeta': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "meta", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["meta"]) -> 'NotificationsMeta': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "meta", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + meta: 'NotificationsMeta', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Notifications': + return super().__new__( + cls, + *_args, + data=data, + meta=meta, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.notification import Notification +from gooddata_api_client.model.notifications_meta import NotificationsMeta diff --git a/gooddata-api-client/gooddata_api_client/model/notifications_meta.pyi b/gooddata-api-client/gooddata_api_client/model/notifications_meta.pyi new file mode 100644 index 000000000..96e602c3d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/notifications_meta.pyi @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class NotificationsMeta( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + @staticmethod + def total() -> typing.Type['NotificationsMetaTotal']: + return NotificationsMetaTotal + __annotations__ = { + "total": total, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["total"]) -> 'NotificationsMetaTotal': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["total", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["total"]) -> typing.Union['NotificationsMetaTotal', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["total", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + total: typing.Union['NotificationsMetaTotal', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'NotificationsMeta': + return super().__new__( + cls, + *_args, + total=total, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.notifications_meta_total import NotificationsMetaTotal diff --git a/gooddata-api-client/gooddata_api_client/model/notifications_meta_total.pyi b/gooddata-api-client/gooddata_api_client/model/notifications_meta_total.pyi new file mode 100644 index 000000000..8d72ffcec --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/notifications_meta_total.pyi @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class NotificationsMetaTotal( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "all", + "unread", + } + + class properties: + all = schemas.Int64Schema + unread = schemas.Int64Schema + __annotations__ = { + "all": all, + "unread": unread, + } + + all: MetaOapg.properties.all + unread: MetaOapg.properties.unread + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["all"]) -> MetaOapg.properties.all: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["unread"]) -> MetaOapg.properties.unread: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["all", "unread", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["all"]) -> MetaOapg.properties.all: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["unread"]) -> MetaOapg.properties.unread: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["all", "unread", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + all: typing.Union[MetaOapg.properties.all, decimal.Decimal, int, ], + unread: typing.Union[MetaOapg.properties.unread, decimal.Decimal, int, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'NotificationsMetaTotal': + return super().__new__( + cls, + *_args, + all=all, + unread=unread, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/open_ai_api_key_auth.py b/gooddata-api-client/gooddata_api_client/model/open_ai_api_key_auth.py new file mode 100644 index 000000000..9f57d5014 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/open_ai_api_key_auth.py @@ -0,0 +1,332 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.open_ai_api_key_auth_all_of import OpenAiApiKeyAuthAllOf + globals()['OpenAiApiKeyAuthAllOf'] = OpenAiApiKeyAuthAllOf + + +class OpenAiApiKeyAuth(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',): { + 'API_KEY': "API_KEY", + }, + } + + validations = { + ('api_key',): { + '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 { + 'type': (str,), # noqa: E501 + 'api_key': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'api_key': 'apiKey', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OpenAiApiKeyAuth - a model defined in OpenAPI + + Keyword Args: + type (str): Authentication type.. defaults to "API_KEY", must be one of ["API_KEY", ] # 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,) + api_key (str, none_type): OpenAI API key.. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "API_KEY") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_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 + """OpenAiApiKeyAuth - a model defined in OpenAPI + + Keyword Args: + type (str): Authentication type.. defaults to "API_KEY", must be one of ["API_KEY", ] # 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,) + api_key (str, none_type): OpenAI API key.. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "API_KEY") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_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': [ + OpenAiApiKeyAuthAllOf, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/open_ai_api_key_auth.pyi b/gooddata-api-client/gooddata_api_client/model/open_ai_api_key_auth.pyi new file mode 100644 index 000000000..444b282b2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/open_ai_api_key_auth.pyi @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class OpenAiApiKeyAuth( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "type", + } + + + class all_of_0( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class apiKey( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'apiKey': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def API_KEY(cls): + return cls("API_KEY") + __annotations__ = { + "apiKey": apiKey, + "type": type, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["apiKey"]) -> MetaOapg.properties.apiKey: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["apiKey", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["apiKey"]) -> typing.Union[MetaOapg.properties.apiKey, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> typing.Union[MetaOapg.properties.type, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["apiKey", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + apiKey: typing.Union[MetaOapg.properties.apiKey, None, str, schemas.Unset] = schemas.unset, + type: typing.Union[MetaOapg.properties.type, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + apiKey=apiKey, + type=type, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + ] + + + type: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'OpenAiApiKeyAuth': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/open_ai_api_key_auth_all_of.py b/gooddata-api-client/gooddata_api_client/model/open_ai_api_key_auth_all_of.py new file mode 100644 index 000000000..60cef866a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/open_ai_api_key_auth_all_of.py @@ -0,0 +1,274 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class OpenAiApiKeyAuthAllOf(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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',): { + 'API_KEY': "API_KEY", + }, + } + + validations = { + ('api_key',): { + '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 { + 'api_key': (str, none_type,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'api_key': 'apiKey', # 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 + """OpenAiApiKeyAuthAllOf - 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,) + api_key (str, none_type): OpenAI API key.. [optional] # noqa: E501 + type (str): Authentication type.. [optional] if omitted the server will use the default value of "API_KEY" # 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 + """OpenAiApiKeyAuthAllOf - 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,) + api_key (str, none_type): OpenAI API key.. [optional] # noqa: E501 + type (str): Authentication type.. [optional] if omitted the server will use the default value of "API_KEY" # 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/open_ai_provider_auth.py b/gooddata-api-client/gooddata_api_client/model/open_ai_provider_auth.py new file mode 100644 index 000000000..ad3876a86 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/open_ai_provider_auth.py @@ -0,0 +1,330 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.open_ai_api_key_auth import OpenAiApiKeyAuth + globals()['OpenAiApiKeyAuth'] = OpenAiApiKeyAuth + + +class OpenAiProviderAuth(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',): { + 'API_KEY': "API_KEY", + }, + } + + validations = { + ('api_key',): { + '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 { + 'api_key': (str, none_type,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'api_key': 'apiKey', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OpenAiProviderAuth - 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,) + api_key (str, none_type): OpenAI API key.. [optional] # noqa: E501 + type (str): Authentication type.. [optional] if omitted the server will use the default value of "API_KEY" # 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 + """OpenAiProviderAuth - 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,) + api_key (str, none_type): OpenAI API key.. [optional] # noqa: E501 + type (str): Authentication type.. [optional] if omitted the server will use the default value of "API_KEY" # 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': [ + OpenAiApiKeyAuth, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/open_ai_provider_auth.pyi b/gooddata-api-client/gooddata_api_client/model/open_ai_provider_auth.pyi new file mode 100644 index 000000000..d7db2574c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/open_ai_provider_auth.pyi @@ -0,0 +1,70 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class OpenAiProviderAuth( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Authentication configuration. + """ + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + OpenAiApiKeyAuth, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'OpenAiProviderAuth': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.open_ai_api_key_auth import OpenAiApiKeyAuth diff --git a/gooddata-api-client/gooddata_api_client/model/open_ai_provider_config.py b/gooddata-api-client/gooddata_api_client/model/open_ai_provider_config.py new file mode 100644 index 000000000..a1532e10d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/open_ai_provider_config.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.open_ai_provider_auth import OpenAiProviderAuth + globals()['OpenAiProviderAuth'] = OpenAiProviderAuth + + +class OpenAIProviderConfig(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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',): { + 'OPENAI': "OPENAI", + }, + } + + validations = { + ('base_url',): { + 'max_length': 255, + }, + ('organization',): { + '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 { + 'auth': (OpenAiProviderAuth,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'base_url': (str, none_type,), # noqa: E501 + 'organization': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'auth': 'auth', # noqa: E501 + 'type': 'type', # noqa: E501 + 'base_url': 'baseUrl', # noqa: E501 + 'organization': 'organization', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, auth, *args, **kwargs): # noqa: E501 + """OpenAIProviderConfig - a model defined in OpenAPI + + Args: + auth (OpenAiProviderAuth): + + Keyword Args: + type (str): Provider type.. defaults to "OPENAI", must be one of ["OPENAI", ] # 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,) + base_url (str, none_type): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com" # noqa: E501 + organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "OPENAI") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.auth = auth + 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, auth, *args, **kwargs): # noqa: E501 + """OpenAIProviderConfig - a model defined in OpenAPI + + Args: + auth (OpenAiProviderAuth): + + Keyword Args: + type (str): Provider type.. defaults to "OPENAI", must be one of ["OPENAI", ] # 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,) + base_url (str, none_type): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com" # noqa: E501 + organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "OPENAI") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.auth = auth + 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/open_ai_provider_config.pyi b/gooddata-api-client/gooddata_api_client/model/open_ai_provider_config.pyi new file mode 100644 index 000000000..2f1db708f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/open_ai_provider_config.pyi @@ -0,0 +1,176 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class OpenAIProviderConfig( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Configuration for OpenAI provider. + """ + + + class MetaOapg: + required = { + "auth", + "type", + } + + class properties: + + @staticmethod + def auth() -> typing.Type['OpenAiProviderAuth']: + return OpenAiProviderAuth + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def OPENAI(cls): + return cls("OPENAI") + + + class baseUrl( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'baseUrl': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class organization( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'organization': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + __annotations__ = { + "auth": auth, + "type": type, + "baseUrl": baseUrl, + "organization": organization, + } + + auth: 'OpenAiProviderAuth' + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["auth"]) -> 'OpenAiProviderAuth': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["baseUrl"]) -> MetaOapg.properties.baseUrl: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["organization"]) -> MetaOapg.properties.organization: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["auth", "type", "baseUrl", "organization", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["auth"]) -> 'OpenAiProviderAuth': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["baseUrl"]) -> typing.Union[MetaOapg.properties.baseUrl, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["organization"]) -> typing.Union[MetaOapg.properties.organization, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["auth", "type", "baseUrl", "organization", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + auth: 'OpenAiProviderAuth', + type: typing.Union[MetaOapg.properties.type, str, ], + baseUrl: typing.Union[MetaOapg.properties.baseUrl, None, str, schemas.Unset] = schemas.unset, + organization: typing.Union[MetaOapg.properties.organization, None, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'OpenAIProviderConfig': + return super().__new__( + cls, + *_args, + auth=auth, + type=type, + baseUrl=baseUrl, + organization=organization, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.open_ai_provider_auth import OpenAiProviderAuth diff --git a/gooddata-api-client/gooddata_api_client/model/operation.py b/gooddata-api-client/gooddata_api_client/model/operation.py index 830b9e34d..55389ecca 100644 --- a/gooddata-api-client/gooddata_api_client/model/operation.py +++ b/gooddata-api-client/gooddata_api_client/model/operation.py @@ -67,6 +67,7 @@ class Operation(ModelNormal): ('kind',): { 'PROVISION-DATABASE': "provision-database", 'DEPROVISION-DATABASE': "deprovision-database", + 'RUN-SERVICE-COMMAND': "run-service-command", }, } @@ -105,9 +106,6 @@ def openapi_types(): def discriminator(): lazy_import() val = { - 'FailedOperation': FailedOperation, - 'PendingOperation': PendingOperation, - 'SucceededOperation': SucceededOperation, 'failed': FailedOperation, 'pending': PendingOperation, 'succeeded': SucceededOperation, @@ -134,7 +132,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. + 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. status (str): Keyword Args: @@ -227,7 +225,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. + 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. status (str): Keyword Args: diff --git a/gooddata-api-client/gooddata_api_client/model/operation.pyi b/gooddata-api-client/gooddata_api_client/model/operation.pyi new file mode 100644 index 000000000..6efcda358 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/operation.pyi @@ -0,0 +1,141 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Operation( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Represents a Long-Running Operation: a process that takes some time to complete. + """ + + + class MetaOapg: + required = { + "kind", + "id", + "status", + } + + @staticmethod + def discriminator(): + return { + 'status': { + 'failed': FailedOperation, + 'pending': PendingOperation, + 'succeeded': SucceededOperation, + } + } + + class properties: + id = schemas.StrSchema + + + class kind( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PROVISIONDATABASE(cls): + return cls("provision-database") + + @schemas.classproperty + def DEPROVISIONDATABASE(cls): + return cls("deprovision-database") + + @schemas.classproperty + def RUNSERVICECOMMAND(cls): + return cls("run-service-command") + status = schemas.StrSchema + __annotations__ = { + "id": id, + "kind": kind, + "status": status, + } + + kind: MetaOapg.properties.kind + id: MetaOapg.properties.id + status: MetaOapg.properties.status + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["kind"]) -> MetaOapg.properties.kind: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "kind", "status", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["kind"]) -> MetaOapg.properties.kind: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "kind", "status", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + kind: typing.Union[MetaOapg.properties.kind, str, ], + id: typing.Union[MetaOapg.properties.id, str, ], + status: typing.Union[MetaOapg.properties.status, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Operation': + return super().__new__( + cls, + *_args, + kind=kind, + id=id, + status=status, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.failed_operation import FailedOperation +from gooddata_api_client.model.pending_operation import PendingOperation +from gooddata_api_client.model.succeeded_operation import SucceededOperation diff --git a/gooddata-api-client/gooddata_api_client/model/operation_error.pyi b/gooddata-api-client/gooddata_api_client/model/operation_error.pyi new file mode 100644 index 000000000..4c3099cbd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/operation_error.pyi @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class OperationError( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Error information for a failed operation + """ + + + class MetaOapg: + required = { + "detail", + "title", + "status", + } + + class properties: + detail = schemas.StrSchema + status = schemas.Int32Schema + title = schemas.StrSchema + __annotations__ = { + "detail": detail, + "status": status, + "title": title, + } + + detail: MetaOapg.properties.detail + title: MetaOapg.properties.title + status: MetaOapg.properties.status + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["detail"]) -> MetaOapg.properties.detail: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["detail", "status", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["detail"]) -> MetaOapg.properties.detail: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["detail", "status", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + detail: typing.Union[MetaOapg.properties.detail, str, ], + title: typing.Union[MetaOapg.properties.title, str, ], + status: typing.Union[MetaOapg.properties.status, decimal.Decimal, int, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'OperationError': + return super().__new__( + cls, + *_args, + detail=detail, + title=title, + status=status, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/organization_automation_identifier.pyi b/gooddata-api-client/gooddata_api_client/model/organization_automation_identifier.pyi new file mode 100644 index 000000000..f38d5a375 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/organization_automation_identifier.pyi @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class OrganizationAutomationIdentifier( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "id", + "workspaceId", + } + + class properties: + id = schemas.StrSchema + workspaceId = schemas.StrSchema + __annotations__ = { + "id": id, + "workspaceId": workspaceId, + } + + id: MetaOapg.properties.id + workspaceId: MetaOapg.properties.workspaceId + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workspaceId"]) -> MetaOapg.properties.workspaceId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "workspaceId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workspaceId"]) -> MetaOapg.properties.workspaceId: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "workspaceId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + workspaceId: typing.Union[MetaOapg.properties.workspaceId, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'OrganizationAutomationIdentifier': + return super().__new__( + cls, + *_args, + id=id, + workspaceId=workspaceId, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/organization_automation_management_bulk_request.pyi b/gooddata-api-client/gooddata_api_client/model/organization_automation_management_bulk_request.pyi new file mode 100644 index 000000000..d50ad9c39 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/organization_automation_management_bulk_request.pyi @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class OrganizationAutomationManagementBulkRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "automations", + } + + class properties: + + + class automations( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['OrganizationAutomationIdentifier']: + return OrganizationAutomationIdentifier + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['OrganizationAutomationIdentifier'], typing.List['OrganizationAutomationIdentifier']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'automations': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'OrganizationAutomationIdentifier': + return super().__getitem__(i) + __annotations__ = { + "automations": automations, + } + + automations: MetaOapg.properties.automations + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["automations"]) -> MetaOapg.properties.automations: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["automations", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["automations"]) -> MetaOapg.properties.automations: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["automations", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + automations: typing.Union[MetaOapg.properties.automations, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'OrganizationAutomationManagementBulkRequest': + return super().__new__( + cls, + *_args, + automations=automations, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.organization_automation_identifier import OrganizationAutomationIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/organization_permission_assignment.pyi b/gooddata-api-client/gooddata_api_client/model/organization_permission_assignment.pyi new file mode 100644 index 000000000..efa1bf9fa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/organization_permission_assignment.pyi @@ -0,0 +1,142 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class OrganizationPermissionAssignment( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Organization permission assignments + """ + + + class MetaOapg: + required = { + "assigneeIdentifier", + "permissions", + } + + class properties: + + @staticmethod + def assigneeIdentifier() -> typing.Type['AssigneeIdentifier']: + return AssigneeIdentifier + + + class permissions( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MANAGE(cls): + return cls("MANAGE") + + @schemas.classproperty + def SELF_CREATE_TOKEN(cls): + return cls("SELF_CREATE_TOKEN") + + @schemas.classproperty + def BASE_UI_ACCESS(cls): + return cls("BASE_UI_ACCESS") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'permissions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "assigneeIdentifier": assigneeIdentifier, + "permissions": permissions, + } + + assigneeIdentifier: 'AssigneeIdentifier' + permissions: MetaOapg.properties.permissions + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["assigneeIdentifier"]) -> 'AssigneeIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["assigneeIdentifier", "permissions", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["assigneeIdentifier"]) -> 'AssigneeIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["assigneeIdentifier", "permissions", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + assigneeIdentifier: 'AssigneeIdentifier', + permissions: typing.Union[MetaOapg.properties.permissions, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'OrganizationPermissionAssignment': + return super().__new__( + cls, + *_args, + assigneeIdentifier=assigneeIdentifier, + permissions=permissions, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/outlier_detection_request.pyi b/gooddata-api-client/gooddata_api_client/model/outlier_detection_request.pyi new file mode 100644 index 000000000..e80cf9b68 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/outlier_detection_request.pyi @@ -0,0 +1,328 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class OutlierDetectionRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "measures", + "granularity", + "attributes", + "filters", + "sensitivity", + } + + class properties: + + + class attributes( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AttributeItem']: + return AttributeItem + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AttributeItem'], typing.List['AttributeItem']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attributes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AttributeItem': + return super().__getitem__(i) + + + class filters( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AbstractMeasureValueFilter, + FilterDefinitionForSimpleMeasure, + InlineFilterDefinition, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'filters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class granularity( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def HOUR(cls): + return cls("HOUR") + + @schemas.classproperty + def DAY(cls): + return cls("DAY") + + @schemas.classproperty + def WEEK(cls): + return cls("WEEK") + + @schemas.classproperty + def MONTH(cls): + return cls("MONTH") + + @schemas.classproperty + def QUARTER(cls): + return cls("QUARTER") + + @schemas.classproperty + def YEAR(cls): + return cls("YEAR") + + + class measures( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['MeasureItem']: + return MeasureItem + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['MeasureItem'], typing.List['MeasureItem']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'measures': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'MeasureItem': + return super().__getitem__(i) + + + class sensitivity( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def LOW(cls): + return cls("LOW") + + @schemas.classproperty + def MEDIUM(cls): + return cls("MEDIUM") + + @schemas.classproperty + def HIGH(cls): + return cls("HIGH") + + + class auxMeasures( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['MeasureItem']: + return MeasureItem + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['MeasureItem'], typing.List['MeasureItem']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'auxMeasures': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'MeasureItem': + return super().__getitem__(i) + __annotations__ = { + "attributes": attributes, + "filters": filters, + "granularity": granularity, + "measures": measures, + "sensitivity": sensitivity, + "auxMeasures": auxMeasures, + } + + measures: MetaOapg.properties.measures + granularity: MetaOapg.properties.granularity + attributes: MetaOapg.properties.attributes + filters: MetaOapg.properties.filters + sensitivity: MetaOapg.properties.sensitivity + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["measures"]) -> MetaOapg.properties.measures: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sensitivity"]) -> MetaOapg.properties.sensitivity: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["auxMeasures"]) -> MetaOapg.properties.auxMeasures: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", "filters", "granularity", "measures", "sensitivity", "auxMeasures", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["measures"]) -> MetaOapg.properties.measures: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sensitivity"]) -> MetaOapg.properties.sensitivity: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["auxMeasures"]) -> typing.Union[MetaOapg.properties.auxMeasures, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", "filters", "granularity", "measures", "sensitivity", "auxMeasures", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + measures: typing.Union[MetaOapg.properties.measures, list, tuple, ], + granularity: typing.Union[MetaOapg.properties.granularity, str, ], + attributes: typing.Union[MetaOapg.properties.attributes, list, tuple, ], + filters: typing.Union[MetaOapg.properties.filters, list, tuple, ], + sensitivity: typing.Union[MetaOapg.properties.sensitivity, str, ], + auxMeasures: typing.Union[MetaOapg.properties.auxMeasures, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'OutlierDetectionRequest': + return super().__new__( + cls, + *_args, + measures=measures, + granularity=granularity, + attributes=attributes, + filters=filters, + sensitivity=sensitivity, + auxMeasures=auxMeasures, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.abstract_measure_value_filter import AbstractMeasureValueFilter +from gooddata_api_client.model.attribute_item import AttributeItem +from gooddata_api_client.model.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure +from gooddata_api_client.model.inline_filter_definition import InlineFilterDefinition +from gooddata_api_client.model.measure_item import MeasureItem diff --git a/gooddata-api-client/gooddata_api_client/model/outlier_detection_response.pyi b/gooddata-api-client/gooddata_api_client/model/outlier_detection_response.pyi new file mode 100644 index 000000000..a5bc42c0b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/outlier_detection_response.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class OutlierDetectionResponse( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "links", + } + + class properties: + + @staticmethod + def links() -> typing.Type['ExecutionLinks']: + return ExecutionLinks + __annotations__ = { + "links": links, + } + + links: 'ExecutionLinks' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ExecutionLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> 'ExecutionLinks': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + links: 'ExecutionLinks', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'OutlierDetectionResponse': + return super().__new__( + cls, + *_args, + links=links, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.execution_links import ExecutionLinks diff --git a/gooddata-api-client/gooddata_api_client/model/outlier_detection_result.pyi b/gooddata-api-client/gooddata_api_client/model/outlier_detection_result.pyi new file mode 100644 index 000000000..75a89433a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/outlier_detection_result.pyi @@ -0,0 +1,193 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class OutlierDetectionResult( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "values", + "attribute", + } + + class properties: + + + class attribute( + schemas.ListBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneTupleMixin + ): + + + class MetaOapg: + items = schemas.StrSchema + + + def __new__( + cls, + *_args: typing.Union[list, tuple, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attribute': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class values( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin + ): + + + class MetaOapg: + + + class additional_properties( + schemas.ListBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneTupleMixin + ): + + + class MetaOapg: + + + class items( + schemas.NumberBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneDecimalMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, decimal.Decimal, int, float, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'items': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + def __new__( + cls, + *_args: typing.Union[list, tuple, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'additional_properties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, list, tuple, None, ], + ) -> 'values': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "attribute": attribute, + "values": values, + } + + values: MetaOapg.properties.values + attribute: MetaOapg.properties.attribute + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attribute"]) -> MetaOapg.properties.attribute: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["values"]) -> MetaOapg.properties.values: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attribute", "values", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attribute"]) -> MetaOapg.properties.attribute: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["values"]) -> MetaOapg.properties.values: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attribute", "values", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + values: typing.Union[MetaOapg.properties.values, dict, frozendict.frozendict, None, ], + attribute: typing.Union[MetaOapg.properties.attribute, list, tuple, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'OutlierDetectionResult': + return super().__new__( + cls, + *_args, + values=values, + attribute=attribute, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/over.pyi b/gooddata-api-client/gooddata_api_client/model/over.pyi new file mode 100644 index 000000000..1a87fd122 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/over.pyi @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Over( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "attributes", + } + + class properties: + + + class attributes( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['IdentifierRef']: + return IdentifierRef + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['IdentifierRef'], typing.List['IdentifierRef']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'attributes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'IdentifierRef': + return super().__getitem__(i) + __annotations__ = { + "attributes": attributes, + } + + attributes: MetaOapg.properties.attributes + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["attributes", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["attributes"]) -> MetaOapg.properties.attributes: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["attributes", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + attributes: typing.Union[MetaOapg.properties.attributes, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Over': + return super().__new__( + cls, + *_args, + attributes=attributes, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.identifier_ref import IdentifierRef diff --git a/gooddata-api-client/gooddata_api_client/model/page_metadata.pyi b/gooddata-api-client/gooddata_api_client/model/page_metadata.pyi new file mode 100644 index 000000000..33d2d4bd2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/page_metadata.pyi @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class PageMetadata( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + number = schemas.Int32Schema + size = schemas.Int32Schema + totalElements = schemas.Int32Schema + totalPages = schemas.Int32Schema + __annotations__ = { + "number": number, + "size": size, + "totalElements": totalElements, + "totalPages": totalPages, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["number"]) -> MetaOapg.properties.number: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["size"]) -> MetaOapg.properties.size: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["totalElements"]) -> MetaOapg.properties.totalElements: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["totalPages"]) -> MetaOapg.properties.totalPages: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["number", "size", "totalElements", "totalPages", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["number"]) -> typing.Union[MetaOapg.properties.number, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["size"]) -> typing.Union[MetaOapg.properties.size, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["totalElements"]) -> typing.Union[MetaOapg.properties.totalElements, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["totalPages"]) -> typing.Union[MetaOapg.properties.totalPages, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["number", "size", "totalElements", "totalPages", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + number: typing.Union[MetaOapg.properties.number, decimal.Decimal, int, schemas.Unset] = schemas.unset, + size: typing.Union[MetaOapg.properties.size, decimal.Decimal, int, schemas.Unset] = schemas.unset, + totalElements: typing.Union[MetaOapg.properties.totalElements, decimal.Decimal, int, schemas.Unset] = schemas.unset, + totalPages: typing.Union[MetaOapg.properties.totalPages, decimal.Decimal, int, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'PageMetadata': + return super().__new__( + cls, + *_args, + number=number, + size=size, + totalElements=totalElements, + totalPages=totalPages, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/patch_knowledge_document_request_dto.py b/gooddata-api-client/gooddata_api_client/model/patch_knowledge_document_request_dto.py new file mode 100644 index 000000000..509be98a5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/patch_knowledge_document_request_dto.py @@ -0,0 +1,272 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class PatchKnowledgeDocumentRequestDto(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'is_disabled': (bool,), # noqa: E501 + 'scopes': ([str],), # noqa: E501 + 'title': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'is_disabled': 'isDisabled', # noqa: E501 + 'scopes': 'scopes', # 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 + """PatchKnowledgeDocumentRequestDto - 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,) + is_disabled (bool): [optional] # noqa: E501 + scopes ([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 + """PatchKnowledgeDocumentRequestDto - 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,) + is_disabled (bool): [optional] # noqa: E501 + scopes ([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/patch_knowledge_document_request_dto.pyi b/gooddata-api-client/gooddata_api_client/model/patch_knowledge_document_request_dto.pyi new file mode 100644 index 000000000..c9dc8a2dd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/patch_knowledge_document_request_dto.pyi @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class PatchKnowledgeDocumentRequestDto( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + isDisabled = schemas.BoolSchema + + + class scopes( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'scopes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + __annotations__ = { + "isDisabled": isDisabled, + "scopes": scopes, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isDisabled"]) -> MetaOapg.properties.isDisabled: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["scopes"]) -> MetaOapg.properties.scopes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["isDisabled", "scopes", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isDisabled"]) -> typing.Union[MetaOapg.properties.isDisabled, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["scopes"]) -> typing.Union[MetaOapg.properties.scopes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["isDisabled", "scopes", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + isDisabled: typing.Union[MetaOapg.properties.isDisabled, bool, schemas.Unset] = schemas.unset, + scopes: typing.Union[MetaOapg.properties.scopes, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'PatchKnowledgeDocumentRequestDto': + return super().__new__( + cls, + *_args, + isDisabled=isDisabled, + scopes=scopes, + title=title, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/pdf_table_style.pyi b/gooddata-api-client/gooddata_api_client/model/pdf_table_style.pyi new file mode 100644 index 000000000..49b509082 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/pdf_table_style.pyi @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class PdfTableStyle( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Custom CSS styles for the table. (PDF, HTML) + """ + + + class MetaOapg: + required = { + "selector", + } + + class properties: + selector = schemas.StrSchema + + + class properties( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['PdfTableStyleProperty']: + return PdfTableStyleProperty + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['PdfTableStyleProperty'], typing.List['PdfTableStyleProperty']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'properties': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'PdfTableStyleProperty': + return super().__getitem__(i) + __annotations__ = { + "selector": selector, + "properties": properties, + } + + selector: MetaOapg.properties.selector + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["selector"]) -> MetaOapg.properties.selector: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["properties"]) -> MetaOapg.properties.properties: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["selector", "properties", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["selector"]) -> MetaOapg.properties.selector: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["properties"]) -> typing.Union[MetaOapg.properties.properties, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["selector", "properties", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + selector: typing.Union[MetaOapg.properties.selector, str, ], + properties: typing.Union[MetaOapg.properties.properties, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'PdfTableStyle': + return super().__new__( + cls, + *_args, + selector=selector, + properties=properties, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.pdf_table_style_property import PdfTableStyleProperty diff --git a/gooddata-api-client/gooddata_api_client/model/pdf_table_style_property.pyi b/gooddata-api-client/gooddata_api_client/model/pdf_table_style_property.pyi new file mode 100644 index 000000000..c2ea42f9b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/pdf_table_style_property.pyi @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class PdfTableStyleProperty( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + CSS property. + """ + + + class MetaOapg: + required = { + "value", + "key", + } + + class properties: + key = schemas.StrSchema + value = schemas.StrSchema + __annotations__ = { + "key": key, + "value": value, + } + + value: MetaOapg.properties.value + key: MetaOapg.properties.key + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["key"]) -> MetaOapg.properties.key: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["key", "value", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["key"]) -> MetaOapg.properties.key: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["key", "value", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + value: typing.Union[MetaOapg.properties.value, str, ], + key: typing.Union[MetaOapg.properties.key, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'PdfTableStyleProperty': + return super().__new__( + cls, + *_args, + value=value, + key=key, + _configuration=_configuration, + **kwargs, + ) 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 189db9c32..0c9454a91 100644 --- a/gooddata-api-client/gooddata_api_client/model/pending_operation.py +++ b/gooddata-api-client/gooddata_api_client/model/pending_operation.py @@ -31,14 +31,8 @@ def lazy_import(): - from gooddata_api_client.model.failed_operation import FailedOperation from gooddata_api_client.model.operation import Operation - from gooddata_api_client.model.pending_operation import PendingOperation - from gooddata_api_client.model.succeeded_operation import SucceededOperation - globals()['FailedOperation'] = FailedOperation globals()['Operation'] = Operation - globals()['PendingOperation'] = PendingOperation - globals()['SucceededOperation'] = SucceededOperation class PendingOperation(ModelComposed): @@ -69,6 +63,7 @@ class PendingOperation(ModelComposed): ('kind',): { 'PROVISION-DATABASE': "provision-database", 'DEPROVISION-DATABASE': "deprovision-database", + 'RUN-SERVICE-COMMAND': "run-service-command", }, } @@ -105,11 +100,7 @@ def openapi_types(): @cached_property def discriminator(): - lazy_import() val = { - 'failed': FailedOperation, - 'pending': PendingOperation, - 'succeeded': SucceededOperation, } if not val: return None @@ -131,7 +122,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Keyword 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. + 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. status (str): _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be @@ -237,7 +228,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Keyword 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. + 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. status (str): _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be diff --git a/gooddata-api-client/gooddata_api_client/model/pending_operation.pyi b/gooddata-api-client/gooddata_api_client/model/pending_operation.pyi new file mode 100644 index 000000000..e9bd43cd9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/pending_operation.pyi @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class PendingOperation( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Operation that is still pending + """ + + + class MetaOapg: + required = { + "kind", + "id", + } + + @staticmethod + def discriminator(): + return { + 'status': { + 'failed': FailedOperation, + 'pending': PendingOperation, + 'succeeded': SucceededOperation, + } + } + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + Operation, + ] + + + kind: schemas.AnyTypeSchema + id: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'PendingOperation': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.failed_operation import FailedOperation +from gooddata_api_client.model.operation import Operation +from gooddata_api_client.model.pending_operation import PendingOperation +from gooddata_api_client.model.succeeded_operation import SucceededOperation diff --git a/gooddata-api-client/gooddata_api_client/model/permissions_assignment.pyi b/gooddata-api-client/gooddata_api_client/model/permissions_assignment.pyi new file mode 100644 index 000000000..b7f2c0118 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/permissions_assignment.pyi @@ -0,0 +1,183 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class PermissionsAssignment( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "assignees", + } + + class properties: + + + class assignees( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AssigneeIdentifier']: + return AssigneeIdentifier + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AssigneeIdentifier'], typing.List['AssigneeIdentifier']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'assignees': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AssigneeIdentifier': + return super().__getitem__(i) + + + class dataSources( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['UserManagementDataSourcePermissionAssignment']: + return UserManagementDataSourcePermissionAssignment + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['UserManagementDataSourcePermissionAssignment'], typing.List['UserManagementDataSourcePermissionAssignment']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dataSources': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'UserManagementDataSourcePermissionAssignment': + return super().__getitem__(i) + + + class workspaces( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['UserManagementWorkspacePermissionAssignment']: + return UserManagementWorkspacePermissionAssignment + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['UserManagementWorkspacePermissionAssignment'], typing.List['UserManagementWorkspacePermissionAssignment']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'workspaces': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'UserManagementWorkspacePermissionAssignment': + return super().__getitem__(i) + __annotations__ = { + "assignees": assignees, + "dataSources": dataSources, + "workspaces": workspaces, + } + + assignees: MetaOapg.properties.assignees + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["assignees"]) -> MetaOapg.properties.assignees: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataSources"]) -> MetaOapg.properties.dataSources: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workspaces"]) -> MetaOapg.properties.workspaces: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["assignees", "dataSources", "workspaces", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["assignees"]) -> MetaOapg.properties.assignees: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataSources"]) -> typing.Union[MetaOapg.properties.dataSources, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workspaces"]) -> typing.Union[MetaOapg.properties.workspaces, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["assignees", "dataSources", "workspaces", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + assignees: typing.Union[MetaOapg.properties.assignees, list, tuple, ], + dataSources: typing.Union[MetaOapg.properties.dataSources, list, tuple, schemas.Unset] = schemas.unset, + workspaces: typing.Union[MetaOapg.properties.workspaces, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'PermissionsAssignment': + return super().__new__( + cls, + *_args, + assignees=assignees, + dataSources=dataSources, + workspaces=workspaces, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier +from gooddata_api_client.model.user_management_data_source_permission_assignment import UserManagementDataSourcePermissionAssignment +from gooddata_api_client.model.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment diff --git a/gooddata-api-client/gooddata_api_client/model/permissions_for_assignee_rule.pyi b/gooddata-api-client/gooddata_api_client/model/permissions_for_assignee_rule.pyi new file mode 100644 index 000000000..5f44f69be --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/permissions_for_assignee_rule.pyi @@ -0,0 +1,132 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class PermissionsForAssigneeRule( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Desired levels of permissions for a collection of assignees identified by a rule. + """ + + + class MetaOapg: + required = { + "permissions", + "assigneeRule", + } + + + class all_of_1( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + @staticmethod + def assigneeRule() -> typing.Type['AssigneeRule']: + return AssigneeRule + __annotations__ = { + "assigneeRule": assigneeRule, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["assigneeRule"]) -> 'AssigneeRule': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["assigneeRule", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["assigneeRule"]) -> typing.Union['AssigneeRule', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["assigneeRule", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + assigneeRule: typing.Union['AssigneeRule', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + assigneeRule=assigneeRule, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + DashboardPermissionsAssignment, + cls.all_of_1, + ] + + + permissions: schemas.AnyTypeSchema + assigneeRule: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'PermissionsForAssigneeRule': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.assignee_rule import AssigneeRule +from gooddata_api_client.model.dashboard_permissions_assignment import DashboardPermissionsAssignment diff --git a/gooddata-api-client/gooddata_api_client/model/provision_database_instance_request.pyi b/gooddata-api-client/gooddata_api_client/model/provision_database_instance_request.pyi new file mode 100644 index 000000000..b3e73b594 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/provision_database_instance_request.pyi @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ProvisionDatabaseInstanceRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Request to provision a new AILake Database instance + """ + + + class MetaOapg: + required = { + "storageIds", + "name", + } + + class properties: + name = schemas.StrSchema + + + class storageIds( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'storageIds': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "name": name, + "storageIds": storageIds, + } + + storageIds: MetaOapg.properties.storageIds + name: MetaOapg.properties.name + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["storageIds"]) -> MetaOapg.properties.storageIds: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["name", "storageIds", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["storageIds"]) -> MetaOapg.properties.storageIds: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["name", "storageIds", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + storageIds: typing.Union[MetaOapg.properties.storageIds, list, tuple, ], + name: typing.Union[MetaOapg.properties.name, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ProvisionDatabaseInstanceRequest': + return super().__new__( + cls, + *_args, + storageIds=storageIds, + name=name, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/quality_issue.pyi b/gooddata-api-client/gooddata_api_client/model/quality_issue.pyi new file mode 100644 index 000000000..331aa3692 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/quality_issue.pyi @@ -0,0 +1,202 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class QualityIssue( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + List of quality issues (available when status is COMPLETED) + """ + + + class MetaOapg: + required = { + "severity", + "code", + "objects", + "detail", + "id", + } + + class properties: + code = schemas.StrSchema + + + class detail( + schemas.DictSchema + ): + + + class MetaOapg: + additional_properties = schemas.DictSchema + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, dict, frozendict.frozendict, ], + ) -> 'detail': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + id = schemas.StrSchema + + + class objects( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['QualityIssueObject']: + return QualityIssueObject + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['QualityIssueObject'], typing.List['QualityIssueObject']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'objects': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'QualityIssueObject': + return super().__getitem__(i) + + + class severity( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def WARNING(cls): + return cls("WARNING") + + @schemas.classproperty + def INFO(cls): + return cls("INFO") + __annotations__ = { + "code": code, + "detail": detail, + "id": id, + "objects": objects, + "severity": severity, + } + + severity: MetaOapg.properties.severity + code: MetaOapg.properties.code + objects: MetaOapg.properties.objects + detail: MetaOapg.properties.detail + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["code"]) -> MetaOapg.properties.code: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["detail"]) -> MetaOapg.properties.detail: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["objects"]) -> MetaOapg.properties.objects: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["severity"]) -> MetaOapg.properties.severity: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["code", "detail", "id", "objects", "severity", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["code"]) -> MetaOapg.properties.code: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["detail"]) -> MetaOapg.properties.detail: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["objects"]) -> MetaOapg.properties.objects: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["severity"]) -> MetaOapg.properties.severity: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["code", "detail", "id", "objects", "severity", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + severity: typing.Union[MetaOapg.properties.severity, str, ], + code: typing.Union[MetaOapg.properties.code, str, ], + objects: typing.Union[MetaOapg.properties.objects, list, tuple, ], + detail: typing.Union[MetaOapg.properties.detail, dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'QualityIssue': + return super().__new__( + cls, + *_args, + severity=severity, + code=code, + objects=objects, + detail=detail, + id=id, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.quality_issue_object import QualityIssueObject diff --git a/gooddata-api-client/gooddata_api_client/model/quality_issue_object.pyi b/gooddata-api-client/gooddata_api_client/model/quality_issue_object.pyi new file mode 100644 index 000000000..188039169 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/quality_issue_object.pyi @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class QualityIssueObject( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + List of objects affected by this quality issue + """ + + + class MetaOapg: + required = { + "id", + "title", + "type", + "workspaceId", + } + + class properties: + id = schemas.StrSchema + title = schemas.StrSchema + type = schemas.StrSchema + workspaceId = schemas.StrSchema + __annotations__ = { + "id": id, + "title": title, + "type": type, + "workspaceId": workspaceId, + } + + id: MetaOapg.properties.id + title: MetaOapg.properties.title + type: MetaOapg.properties.type + workspaceId: MetaOapg.properties.workspaceId + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workspaceId"]) -> MetaOapg.properties.workspaceId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "title", "type", "workspaceId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workspaceId"]) -> MetaOapg.properties.workspaceId: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "title", "type", "workspaceId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + title: typing.Union[MetaOapg.properties.title, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + workspaceId: typing.Union[MetaOapg.properties.workspaceId, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'QualityIssueObject': + return super().__new__( + cls, + *_args, + id=id, + title=title, + type=type, + workspaceId=workspaceId, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/quality_issues_calculation_status_response.py b/gooddata-api-client/gooddata_api_client/model/quality_issues_calculation_status_response.py index 753a6878a..ff2013a7e 100644 --- a/gooddata-api-client/gooddata_api_client/model/quality_issues_calculation_status_response.py +++ b/gooddata-api-client/gooddata_api_client/model/quality_issues_calculation_status_response.py @@ -65,6 +65,7 @@ class QualityIssuesCalculationStatusResponse(ModelNormal): 'SYNCING': "SYNCING", 'COMPLETED': "COMPLETED", 'FAILED': "FAILED", + 'CANCELLED': "CANCELLED", 'NOT_FOUND': "NOT_FOUND", 'DISABLED': "DISABLED", }, diff --git a/gooddata-api-client/gooddata_api_client/model/quality_issues_calculation_status_response.pyi b/gooddata-api-client/gooddata_api_client/model/quality_issues_calculation_status_response.pyi new file mode 100644 index 000000000..6ab5e2642 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/quality_issues_calculation_status_response.pyi @@ -0,0 +1,164 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class QualityIssuesCalculationStatusResponse( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "status", + } + + class properties: + + + class status( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def RUNNING(cls): + return cls("RUNNING") + + @schemas.classproperty + def SYNCING(cls): + return cls("SYNCING") + + @schemas.classproperty + def COMPLETED(cls): + return cls("COMPLETED") + + @schemas.classproperty + def FAILED(cls): + return cls("FAILED") + + @schemas.classproperty + def CANCELLED(cls): + return cls("CANCELLED") + + @schemas.classproperty + def NOT_FOUND(cls): + return cls("NOT_FOUND") + + @schemas.classproperty + def DISABLED(cls): + return cls("DISABLED") + error = schemas.StrSchema + + + class issues( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['QualityIssue']: + return QualityIssue + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['QualityIssue'], typing.List['QualityIssue']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'issues': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'QualityIssue': + return super().__getitem__(i) + __annotations__ = { + "status": status, + "error": error, + "issues": issues, + } + + status: MetaOapg.properties.status + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["error"]) -> MetaOapg.properties.error: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["issues"]) -> MetaOapg.properties.issues: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["status", "error", "issues", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["error"]) -> typing.Union[MetaOapg.properties.error, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["issues"]) -> typing.Union[MetaOapg.properties.issues, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["status", "error", "issues", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + status: typing.Union[MetaOapg.properties.status, str, ], + error: typing.Union[MetaOapg.properties.error, str, schemas.Unset] = schemas.unset, + issues: typing.Union[MetaOapg.properties.issues, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'QualityIssuesCalculationStatusResponse': + return super().__new__( + cls, + *_args, + status=status, + error=error, + issues=issues, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.quality_issue import QualityIssue diff --git a/gooddata-api-client/gooddata_api_client/model/range.pyi b/gooddata-api-client/gooddata_api_client/model/range.pyi new file mode 100644 index 000000000..0767b85e8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/range.pyi @@ -0,0 +1,142 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Range( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "measure", + "from", + "to", + "operator", + } + + class properties: + + @staticmethod + def _from() -> typing.Type['Value']: + return Value + + @staticmethod + def measure() -> typing.Type['LocalIdentifier']: + return LocalIdentifier + + + class operator( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def BETWEEN(cls): + return cls("BETWEEN") + + @schemas.classproperty + def NOT_BETWEEN(cls): + return cls("NOT_BETWEEN") + + @staticmethod + def to() -> typing.Type['Value']: + return Value + __annotations__ = { + "from": _from, + "measure": measure, + "operator": operator, + "to": to, + } + + measure: 'LocalIdentifier' + to: 'Value' + operator: MetaOapg.properties.operator + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> 'Value': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["measure"]) -> 'LocalIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> 'Value': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["from", "measure", "operator", "to", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> 'Value': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["measure"]) -> 'LocalIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> 'Value': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["from", "measure", "operator", "to", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + measure: 'LocalIdentifier', + to: 'Value', + operator: typing.Union[MetaOapg.properties.operator, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Range': + return super().__new__( + cls, + *_args, + measure=measure, + to=to, + operator=operator, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.local_identifier import LocalIdentifier +from gooddata_api_client.model.value import Value diff --git a/gooddata-api-client/gooddata_api_client/model/range_condition.pyi b/gooddata-api-client/gooddata_api_client/model/range_condition.pyi new file mode 100644 index 000000000..cf72bb887 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/range_condition.pyi @@ -0,0 +1,174 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class RangeCondition( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Condition that checks if the metric value is within a given range. + """ + + + class MetaOapg: + required = { + "range", + } + + class properties: + + + class range( + schemas.DictSchema + ): + + + class MetaOapg: + required = { + "from", + "to", + "operator", + } + + class properties: + _from = schemas.NumberSchema + + + class operator( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def BETWEEN(cls): + return cls("BETWEEN") + + @schemas.classproperty + def NOT_BETWEEN(cls): + return cls("NOT_BETWEEN") + to = schemas.NumberSchema + __annotations__ = { + "from": _from, + "operator": operator, + "to": to, + } + + to: MetaOapg.properties.to + operator: MetaOapg.properties.operator + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> MetaOapg.properties.to: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["from", "operator", "to", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> MetaOapg.properties.to: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["from", "operator", "to", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + to: typing.Union[MetaOapg.properties.to, decimal.Decimal, int, float, ], + operator: typing.Union[MetaOapg.properties.operator, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'range': + return super().__new__( + cls, + *_args, + to=to, + operator=operator, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "range": range, + } + + range: MetaOapg.properties.range + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["range"]) -> MetaOapg.properties.range: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["range", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["range"]) -> MetaOapg.properties.range: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["range", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + range: typing.Union[MetaOapg.properties.range, dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'RangeCondition': + return super().__new__( + cls, + *_args, + range=range, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/range_wrapper.pyi b/gooddata-api-client/gooddata_api_client/model/range_wrapper.pyi new file mode 100644 index 000000000..c24d60c76 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/range_wrapper.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class RangeWrapper( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "range", + } + + class properties: + + @staticmethod + def range() -> typing.Type['Range']: + return Range + __annotations__ = { + "range": range, + } + + range: 'Range' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["range"]) -> 'Range': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["range", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["range"]) -> 'Range': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["range", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + range: 'Range', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'RangeWrapper': + return super().__new__( + cls, + *_args, + range=range, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.range import Range diff --git a/gooddata-api-client/gooddata_api_client/model/raw_custom_label.pyi b/gooddata-api-client/gooddata_api_client/model/raw_custom_label.pyi new file mode 100644 index 000000000..7db09af54 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/raw_custom_label.pyi @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class RawCustomLabel( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Custom label object override. + """ + + + class MetaOapg: + required = { + "title", + } + + class properties: + title = schemas.StrSchema + __annotations__ = { + "title": title, + } + + title: MetaOapg.properties.title + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + title: typing.Union[MetaOapg.properties.title, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'RawCustomLabel': + return super().__new__( + cls, + *_args, + title=title, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/raw_custom_metric.pyi b/gooddata-api-client/gooddata_api_client/model/raw_custom_metric.pyi new file mode 100644 index 000000000..a55e7313f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/raw_custom_metric.pyi @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class RawCustomMetric( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Custom metric object override. + """ + + + class MetaOapg: + required = { + "title", + } + + class properties: + title = schemas.StrSchema + __annotations__ = { + "title": title, + } + + title: MetaOapg.properties.title + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + title: typing.Union[MetaOapg.properties.title, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'RawCustomMetric': + return super().__new__( + cls, + *_args, + title=title, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/raw_custom_override.pyi b/gooddata-api-client/gooddata_api_client/model/raw_custom_override.pyi new file mode 100644 index 000000000..48536c4cd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/raw_custom_override.pyi @@ -0,0 +1,156 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class RawCustomOverride( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Custom cell value overrides (IDs will be replaced with specified values). + """ + + + class MetaOapg: + + class properties: + + + class labels( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['RawCustomLabel']: + return RawCustomLabel + + def __getitem__(self, name: typing.Union[str, ]) -> 'RawCustomLabel': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'RawCustomLabel': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'RawCustomLabel', + ) -> 'labels': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class metrics( + schemas.DictSchema + ): + + + class MetaOapg: + + @staticmethod + def additional_properties() -> typing.Type['RawCustomMetric']: + return RawCustomMetric + + def __getitem__(self, name: typing.Union[str, ]) -> 'RawCustomMetric': + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> 'RawCustomMetric': + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: 'RawCustomMetric', + ) -> 'metrics': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + __annotations__ = { + "labels": labels, + "metrics": metrics, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["labels"]) -> MetaOapg.properties.labels: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metrics"]) -> MetaOapg.properties.metrics: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["labels", "metrics", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["labels"]) -> typing.Union[MetaOapg.properties.labels, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metrics"]) -> typing.Union[MetaOapg.properties.metrics, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["labels", "metrics", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + labels: typing.Union[MetaOapg.properties.labels, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + metrics: typing.Union[MetaOapg.properties.metrics, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'RawCustomOverride': + return super().__new__( + cls, + *_args, + labels=labels, + metrics=metrics, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.raw_custom_label import RawCustomLabel +from gooddata_api_client.model.raw_custom_metric import RawCustomMetric diff --git a/gooddata-api-client/gooddata_api_client/model/raw_export_automation_request.pyi b/gooddata-api-client/gooddata_api_client/model/raw_export_automation_request.pyi new file mode 100644 index 000000000..02f3d5b46 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/raw_export_automation_request.pyi @@ -0,0 +1,189 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class RawExportAutomationRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Export request object describing the export properties and overrides for raw exports. + """ + + + class MetaOapg: + required = { + "execution", + "fileName", + "format", + } + + class properties: + + @staticmethod + def execution() -> typing.Type['AFM']: + return AFM + fileName = schemas.StrSchema + + + class format( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ARROW_FILE(cls): + return cls("ARROW_FILE") + + @schemas.classproperty + def ARROW_STREAM(cls): + return cls("ARROW_STREAM") + + @schemas.classproperty + def CSV(cls): + return cls("CSV") + + @staticmethod + def customOverride() -> typing.Type['RawCustomOverride']: + return RawCustomOverride + + + class delimiter( + schemas.StrSchema + ): + pass + + @staticmethod + def executionSettings() -> typing.Type['ExecutionSettings']: + return ExecutionSettings + + @staticmethod + def metadata() -> typing.Type['JsonNode']: + return JsonNode + __annotations__ = { + "execution": execution, + "fileName": fileName, + "format": format, + "customOverride": customOverride, + "delimiter": delimiter, + "executionSettings": executionSettings, + "metadata": metadata, + } + + execution: 'AFM' + fileName: MetaOapg.properties.fileName + format: MetaOapg.properties.format + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["execution"]) -> 'AFM': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["customOverride"]) -> 'RawCustomOverride': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["delimiter"]) -> MetaOapg.properties.delimiter: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["executionSettings"]) -> 'ExecutionSettings': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metadata"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["execution", "fileName", "format", "customOverride", "delimiter", "executionSettings", "metadata", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["execution"]) -> 'AFM': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["customOverride"]) -> typing.Union['RawCustomOverride', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["delimiter"]) -> typing.Union[MetaOapg.properties.delimiter, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["executionSettings"]) -> typing.Union['ExecutionSettings', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metadata"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["execution", "fileName", "format", "customOverride", "delimiter", "executionSettings", "metadata", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + execution: 'AFM', + fileName: typing.Union[MetaOapg.properties.fileName, str, ], + format: typing.Union[MetaOapg.properties.format, str, ], + customOverride: typing.Union['RawCustomOverride', schemas.Unset] = schemas.unset, + delimiter: typing.Union[MetaOapg.properties.delimiter, str, schemas.Unset] = schemas.unset, + executionSettings: typing.Union['ExecutionSettings', schemas.Unset] = schemas.unset, + metadata: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'RawExportAutomationRequest': + return super().__new__( + cls, + *_args, + execution=execution, + fileName=fileName, + format=format, + customOverride=customOverride, + delimiter=delimiter, + executionSettings=executionSettings, + metadata=metadata, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.afm import AFM +from gooddata_api_client.model.execution_settings import ExecutionSettings +from gooddata_api_client.model.json_node import JsonNode +from gooddata_api_client.model.raw_custom_override import RawCustomOverride diff --git a/gooddata-api-client/gooddata_api_client/model/raw_export_request.pyi b/gooddata-api-client/gooddata_api_client/model/raw_export_request.pyi new file mode 100644 index 000000000..15b2da80a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/raw_export_request.pyi @@ -0,0 +1,175 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class RawExportRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Export request object describing the export properties and overrides for raw exports. + """ + + + class MetaOapg: + required = { + "execution", + "fileName", + "format", + } + + class properties: + + @staticmethod + def execution() -> typing.Type['AFM']: + return AFM + fileName = schemas.StrSchema + + + class format( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ARROW_FILE(cls): + return cls("ARROW_FILE") + + @schemas.classproperty + def ARROW_STREAM(cls): + return cls("ARROW_STREAM") + + @schemas.classproperty + def CSV(cls): + return cls("CSV") + + @staticmethod + def customOverride() -> typing.Type['RawCustomOverride']: + return RawCustomOverride + + + class delimiter( + schemas.StrSchema + ): + pass + + @staticmethod + def executionSettings() -> typing.Type['ExecutionSettings']: + return ExecutionSettings + __annotations__ = { + "execution": execution, + "fileName": fileName, + "format": format, + "customOverride": customOverride, + "delimiter": delimiter, + "executionSettings": executionSettings, + } + + execution: 'AFM' + fileName: MetaOapg.properties.fileName + format: MetaOapg.properties.format + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["execution"]) -> 'AFM': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["customOverride"]) -> 'RawCustomOverride': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["delimiter"]) -> MetaOapg.properties.delimiter: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["executionSettings"]) -> 'ExecutionSettings': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["execution", "fileName", "format", "customOverride", "delimiter", "executionSettings", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["execution"]) -> 'AFM': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["customOverride"]) -> typing.Union['RawCustomOverride', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["delimiter"]) -> typing.Union[MetaOapg.properties.delimiter, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["executionSettings"]) -> typing.Union['ExecutionSettings', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["execution", "fileName", "format", "customOverride", "delimiter", "executionSettings", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + execution: 'AFM', + fileName: typing.Union[MetaOapg.properties.fileName, str, ], + format: typing.Union[MetaOapg.properties.format, str, ], + customOverride: typing.Union['RawCustomOverride', schemas.Unset] = schemas.unset, + delimiter: typing.Union[MetaOapg.properties.delimiter, str, schemas.Unset] = schemas.unset, + executionSettings: typing.Union['ExecutionSettings', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'RawExportRequest': + return super().__new__( + cls, + *_args, + execution=execution, + fileName=fileName, + format=format, + customOverride=customOverride, + delimiter=delimiter, + executionSettings=executionSettings, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.afm import AFM +from gooddata_api_client.model.execution_settings import ExecutionSettings +from gooddata_api_client.model.raw_custom_override import RawCustomOverride diff --git a/gooddata-api-client/gooddata_api_client/model/reasoning.pyi b/gooddata-api-client/gooddata_api_client/model/reasoning.pyi new file mode 100644 index 000000000..7a98207f5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/reasoning.pyi @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Reasoning( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Reasoning wrapper containing steps taken during request handling. + """ + + + class MetaOapg: + required = { + "steps", + } + + class properties: + + + class steps( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ReasoningStep']: + return ReasoningStep + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['ReasoningStep'], typing.List['ReasoningStep']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'steps': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ReasoningStep': + return super().__getitem__(i) + answer = schemas.StrSchema + __annotations__ = { + "steps": steps, + "answer": answer, + } + + steps: MetaOapg.properties.steps + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["steps"]) -> MetaOapg.properties.steps: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["answer"]) -> MetaOapg.properties.answer: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["steps", "answer", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["steps"]) -> MetaOapg.properties.steps: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["answer"]) -> typing.Union[MetaOapg.properties.answer, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["steps", "answer", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + steps: typing.Union[MetaOapg.properties.steps, list, tuple, ], + answer: typing.Union[MetaOapg.properties.answer, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Reasoning': + return super().__new__( + cls, + *_args, + steps=steps, + answer=answer, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.reasoning_step import ReasoningStep diff --git a/gooddata-api-client/gooddata_api_client/model/reasoning_step.pyi b/gooddata-api-client/gooddata_api_client/model/reasoning_step.pyi new file mode 100644 index 000000000..464ed8b38 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/reasoning_step.pyi @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ReasoningStep( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Steps taken during processing, showing the AI's reasoning process. + """ + + + class MetaOapg: + required = { + "thoughts", + "title", + } + + class properties: + + + class thoughts( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['Thought']: + return Thought + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['Thought'], typing.List['Thought']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'thoughts': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'Thought': + return super().__getitem__(i) + title = schemas.StrSchema + __annotations__ = { + "thoughts": thoughts, + "title": title, + } + + thoughts: MetaOapg.properties.thoughts + title: MetaOapg.properties.title + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["thoughts"]) -> MetaOapg.properties.thoughts: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["thoughts", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["thoughts"]) -> MetaOapg.properties.thoughts: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["thoughts", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + thoughts: typing.Union[MetaOapg.properties.thoughts, list, tuple, ], + title: typing.Union[MetaOapg.properties.title, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ReasoningStep': + return super().__new__( + cls, + *_args, + thoughts=thoughts, + title=title, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.thought import Thought diff --git a/gooddata-api-client/gooddata_api_client/model/reference_source_column.pyi b/gooddata-api-client/gooddata_api_client/model/reference_source_column.pyi new file mode 100644 index 000000000..9d9ed0948 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/reference_source_column.pyi @@ -0,0 +1,164 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ReferenceSourceColumn( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "column", + "target", + } + + class properties: + column = schemas.StrSchema + + @staticmethod + def target() -> typing.Type['DatasetGrain']: + return DatasetGrain + + + class dataType( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INT(cls): + return cls("INT") + + @schemas.classproperty + def STRING(cls): + return cls("STRING") + + @schemas.classproperty + def DATE(cls): + return cls("DATE") + + @schemas.classproperty + def NUMERIC(cls): + return cls("NUMERIC") + + @schemas.classproperty + def TIMESTAMP(cls): + return cls("TIMESTAMP") + + @schemas.classproperty + def TIMESTAMP_TZ(cls): + return cls("TIMESTAMP_TZ") + + @schemas.classproperty + def BOOLEAN(cls): + return cls("BOOLEAN") + isNullable = schemas.BoolSchema + nullValue = schemas.StrSchema + __annotations__ = { + "column": column, + "target": target, + "dataType": dataType, + "isNullable": isNullable, + "nullValue": nullValue, + } + + column: MetaOapg.properties.column + target: 'DatasetGrain' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["column"]) -> MetaOapg.properties.column: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["target"]) -> 'DatasetGrain': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataType"]) -> MetaOapg.properties.dataType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isNullable"]) -> MetaOapg.properties.isNullable: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["nullValue"]) -> MetaOapg.properties.nullValue: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["column", "target", "dataType", "isNullable", "nullValue", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["column"]) -> MetaOapg.properties.column: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["target"]) -> 'DatasetGrain': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataType"]) -> typing.Union[MetaOapg.properties.dataType, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isNullable"]) -> typing.Union[MetaOapg.properties.isNullable, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["nullValue"]) -> typing.Union[MetaOapg.properties.nullValue, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["column", "target", "dataType", "isNullable", "nullValue", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + column: typing.Union[MetaOapg.properties.column, str, ], + target: 'DatasetGrain', + dataType: typing.Union[MetaOapg.properties.dataType, str, schemas.Unset] = schemas.unset, + isNullable: typing.Union[MetaOapg.properties.isNullable, bool, schemas.Unset] = schemas.unset, + nullValue: typing.Union[MetaOapg.properties.nullValue, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ReferenceSourceColumn': + return super().__new__( + cls, + *_args, + column=column, + target=target, + dataType=dataType, + isNullable=isNullable, + nullValue=nullValue, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.dataset_grain import DatasetGrain diff --git a/gooddata-api-client/gooddata_api_client/model/relative.pyi b/gooddata-api-client/gooddata_api_client/model/relative.pyi new file mode 100644 index 000000000..6e1369643 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/relative.pyi @@ -0,0 +1,134 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Relative( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "measure", + "threshold", + "operator", + } + + class properties: + + @staticmethod + def measure() -> typing.Type['ArithmeticMeasure']: + return ArithmeticMeasure + + + class operator( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INCREASES_BY(cls): + return cls("INCREASES_BY") + + @schemas.classproperty + def DECREASES_BY(cls): + return cls("DECREASES_BY") + + @schemas.classproperty + def CHANGES_BY(cls): + return cls("CHANGES_BY") + + @staticmethod + def threshold() -> typing.Type['Value']: + return Value + __annotations__ = { + "measure": measure, + "operator": operator, + "threshold": threshold, + } + + measure: 'ArithmeticMeasure' + threshold: 'Value' + operator: MetaOapg.properties.operator + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["measure"]) -> 'ArithmeticMeasure': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["threshold"]) -> 'Value': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["measure", "operator", "threshold", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["measure"]) -> 'ArithmeticMeasure': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["operator"]) -> MetaOapg.properties.operator: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["threshold"]) -> 'Value': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["measure", "operator", "threshold", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + measure: 'ArithmeticMeasure', + threshold: 'Value', + operator: typing.Union[MetaOapg.properties.operator, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Relative': + return super().__new__( + cls, + *_args, + measure=measure, + threshold=threshold, + operator=operator, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.arithmetic_measure import ArithmeticMeasure +from gooddata_api_client.model.value import Value diff --git a/gooddata-api-client/gooddata_api_client/model/relative_bounded_date_filter.pyi b/gooddata-api-client/gooddata_api_client/model/relative_bounded_date_filter.pyi new file mode 100644 index 000000000..b9f7efccc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/relative_bounded_date_filter.pyi @@ -0,0 +1,211 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class RelativeBoundedDateFilter( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "granularity", + } + + class properties: + + + class granularity( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ALL_TIME_GRANULARITY(cls): + return cls("ALL_TIME_GRANULARITY") + + @schemas.classproperty + def GDC_TIME_YEAR(cls): + return cls("GDC.time.year") + + @schemas.classproperty + def GDC_TIME_WEEK_US(cls): + return cls("GDC.time.week_us") + + @schemas.classproperty + def GDC_TIME_WEEK_IN_YEAR(cls): + return cls("GDC.time.week_in_year") + + @schemas.classproperty + def GDC_TIME_WEEK_IN_QUARTER(cls): + return cls("GDC.time.week_in_quarter") + + @schemas.classproperty + def GDC_TIME_WEEK(cls): + return cls("GDC.time.week") + + @schemas.classproperty + def GDC_TIME_EUWEEK_IN_YEAR(cls): + return cls("GDC.time.euweek_in_year") + + @schemas.classproperty + def GDC_TIME_EUWEEK_IN_QUARTER(cls): + return cls("GDC.time.euweek_in_quarter") + + @schemas.classproperty + def GDC_TIME_QUARTER(cls): + return cls("GDC.time.quarter") + + @schemas.classproperty + def GDC_TIME_QUARTER_IN_YEAR(cls): + return cls("GDC.time.quarter_in_year") + + @schemas.classproperty + def GDC_TIME_MONTH(cls): + return cls("GDC.time.month") + + @schemas.classproperty + def GDC_TIME_MONTH_IN_QUARTER(cls): + return cls("GDC.time.month_in_quarter") + + @schemas.classproperty + def GDC_TIME_MONTH_IN_YEAR(cls): + return cls("GDC.time.month_in_year") + + @schemas.classproperty + def GDC_TIME_DAY_IN_YEAR(cls): + return cls("GDC.time.day_in_year") + + @schemas.classproperty + def GDC_TIME_DAY_IN_QUARTER(cls): + return cls("GDC.time.day_in_quarter") + + @schemas.classproperty + def GDC_TIME_DAY_IN_MONTH(cls): + return cls("GDC.time.day_in_month") + + @schemas.classproperty + def GDC_TIME_DAY_IN_WEEK(cls): + return cls("GDC.time.day_in_week") + + @schemas.classproperty + def GDC_TIME_DAY_IN_EUWEEK(cls): + return cls("GDC.time.day_in_euweek") + + @schemas.classproperty + def GDC_TIME_DATE(cls): + return cls("GDC.time.date") + + @schemas.classproperty + def GDC_TIME_HOUR(cls): + return cls("GDC.time.hour") + + @schemas.classproperty + def GDC_TIME_HOUR_IN_DAY(cls): + return cls("GDC.time.hour_in_day") + + @schemas.classproperty + def GDC_TIME_MINUTE(cls): + return cls("GDC.time.minute") + + @schemas.classproperty + def GDC_TIME_MINUTE_IN_HOUR(cls): + return cls("GDC.time.minute_in_hour") + + @schemas.classproperty + def GDC_TIME_FISCAL_MONTH(cls): + return cls("GDC.time.fiscal_month") + + @schemas.classproperty + def GDC_TIME_FISCAL_QUARTER(cls): + return cls("GDC.time.fiscal_quarter") + + @schemas.classproperty + def GDC_TIME_FISCAL_YEAR(cls): + return cls("GDC.time.fiscal_year") + _from = schemas.Int32Schema + to = schemas.Int32Schema + __annotations__ = { + "granularity": granularity, + "from": _from, + "to": to, + } + + granularity: MetaOapg.properties.granularity + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["from"]) -> MetaOapg.properties._from: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["to"]) -> MetaOapg.properties.to: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["granularity", "from", "to", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["granularity"]) -> MetaOapg.properties.granularity: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["from"]) -> typing.Union[MetaOapg.properties._from, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["to"]) -> typing.Union[MetaOapg.properties.to, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["granularity", "from", "to", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + granularity: typing.Union[MetaOapg.properties.granularity, str, ], + to: typing.Union[MetaOapg.properties.to, decimal.Decimal, int, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'RelativeBoundedDateFilter': + return super().__new__( + cls, + *_args, + granularity=granularity, + to=to, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/relative_date_filter_relative_date_filter.py b/gooddata-api-client/gooddata_api_client/model/relative_date_filter_relative_date_filter.py index 0ea3b7dd3..821f386e6 100644 --- a/gooddata-api-client/gooddata_api_client/model/relative_date_filter_relative_date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/relative_date_filter_relative_date_filter.py @@ -62,11 +62,6 @@ class RelativeDateFilterRelativeDateFilter(ModelNormal): """ allowed_values = { - ('empty_value_handling',): { - 'INCLUDE': "INCLUDE", - 'EXCLUDE': "EXCLUDE", - 'ONLY': "ONLY", - }, ('granularity',): { 'MINUTE': "MINUTE", 'HOUR': "HOUR", @@ -88,6 +83,11 @@ class RelativeDateFilterRelativeDateFilter(ModelNormal): 'FISCAL_QUARTER': "FISCAL_QUARTER", 'FISCAL_YEAR': "FISCAL_YEAR", }, + ('empty_value_handling',): { + 'INCLUDE': "INCLUDE", + 'EXCLUDE': "EXCLUDE", + 'ONLY': "ONLY", + }, } validations = { @@ -120,9 +120,9 @@ def openapi_types(): '_from': (int,), # noqa: E501 'granularity': (str,), # noqa: E501 'to': (int,), # noqa: E501 - 'empty_value_handling': (str,), # noqa: E501 'apply_on_result': (bool,), # noqa: E501 'bounded_filter': (BoundedFilter,), # noqa: E501 + 'empty_value_handling': (str,), # noqa: E501 'local_identifier': (str,), # noqa: E501 } @@ -136,9 +136,9 @@ def discriminator(): '_from': 'from', # noqa: E501 'granularity': 'granularity', # noqa: E501 'to': 'to', # noqa: E501 - 'empty_value_handling': 'emptyValueHandling', # noqa: E501 'apply_on_result': 'applyOnResult', # noqa: E501 'bounded_filter': 'boundedFilter', # noqa: E501 + 'empty_value_handling': 'emptyValueHandling', # noqa: E501 'local_identifier': 'localIdentifier', # noqa: E501 } @@ -191,6 +191,7 @@ def _from_openapi_data(cls, dataset, _from, granularity, to, *args, **kwargs): _visited_composed_classes = (Animal,) apply_on_result (bool): [optional] # noqa: E501 bounded_filter (BoundedFilter): [optional] # noqa: E501 + empty_value_handling (str): Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.. [optional] if omitted the server will use the default value of "EXCLUDE" # noqa: E501 local_identifier (str): [optional] # noqa: E501 """ @@ -289,6 +290,7 @@ def __init__(self, dataset, _from, granularity, to, *args, **kwargs): # noqa: E _visited_composed_classes = (Animal,) apply_on_result (bool): [optional] # noqa: E501 bounded_filter (BoundedFilter): [optional] # noqa: E501 + empty_value_handling (str): Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.. [optional] if omitted the server will use the default value of "EXCLUDE" # noqa: E501 local_identifier (str): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/relative_wrapper.pyi b/gooddata-api-client/gooddata_api_client/model/relative_wrapper.pyi new file mode 100644 index 000000000..b69c23962 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/relative_wrapper.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class RelativeWrapper( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "relative", + } + + class properties: + + @staticmethod + def relative() -> typing.Type['Relative']: + return Relative + __annotations__ = { + "relative": relative, + } + + relative: 'Relative' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relative"]) -> 'Relative': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["relative", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relative"]) -> 'Relative': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["relative", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + relative: 'Relative', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'RelativeWrapper': + return super().__new__( + cls, + *_args, + relative=relative, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.relative import Relative diff --git a/gooddata-api-client/gooddata_api_client/model/resolved_llm_endpoint.pyi b/gooddata-api-client/gooddata_api_client/model/resolved_llm_endpoint.pyi new file mode 100644 index 000000000..694de471e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/resolved_llm_endpoint.pyi @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ResolvedLlmEndpoint( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "id", + "title", + } + + class properties: + id = schemas.StrSchema + title = schemas.StrSchema + __annotations__ = { + "id": id, + "title": title, + } + + id: MetaOapg.properties.id + title: MetaOapg.properties.title + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + title: typing.Union[MetaOapg.properties.title, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ResolvedLlmEndpoint': + return super().__new__( + cls, + *_args, + id=id, + title=title, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/resolved_llm_endpoints.pyi b/gooddata-api-client/gooddata_api_client/model/resolved_llm_endpoints.pyi new file mode 100644 index 000000000..dcc5ef7ce --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/resolved_llm_endpoints.pyi @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ResolvedLlmEndpoints( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + } + + class properties: + + + class data( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ResolvedLlmEndpoint']: + return ResolvedLlmEndpoint + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['ResolvedLlmEndpoint'], typing.List['ResolvedLlmEndpoint']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'data': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ResolvedLlmEndpoint': + return super().__getitem__(i) + __annotations__ = { + "data": data, + } + + data: MetaOapg.properties.data + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: typing.Union[MetaOapg.properties.data, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ResolvedLlmEndpoints': + return super().__new__( + cls, + *_args, + data=data, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.resolved_llm_endpoint import ResolvedLlmEndpoint 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 adc933b6f..a5b88bc0a 100644 --- a/gooddata-api-client/gooddata_api_client/model/resolved_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/resolved_setting.py @@ -65,6 +65,7 @@ class ResolvedSetting(ModelNormal): 'ACTIVE_THEME': "ACTIVE_THEME", 'ACTIVE_COLOR_PALETTE': "ACTIVE_COLOR_PALETTE", 'ACTIVE_LLM_ENDPOINT': "ACTIVE_LLM_ENDPOINT", + 'ACTIVE_LLM_PROVIDER': "ACTIVE_LLM_PROVIDER", 'ACTIVE_CALENDARS': "ACTIVE_CALENDARS", 'WHITE_LABELING': "WHITE_LABELING", 'LOCALE': "LOCALE", @@ -108,6 +109,7 @@ class ResolvedSetting(ModelNormal): '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", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/route_result.pyi b/gooddata-api-client/gooddata_api_client/model/route_result.pyi new file mode 100644 index 000000000..33a6085ed --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/route_result.pyi @@ -0,0 +1,135 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class RouteResult( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Question -> Use Case routing. May contain final answer is a special use case is not required. + """ + + + class MetaOapg: + required = { + "useCase", + "reasoning", + } + + class properties: + reasoning = schemas.StrSchema + + + class useCase( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def INVALID(cls): + return cls("INVALID") + + @schemas.classproperty + def GENERAL(cls): + return cls("GENERAL") + + @schemas.classproperty + def SEARCH(cls): + return cls("SEARCH") + + @schemas.classproperty + def CREATE_VISUALIZATION(cls): + return cls("CREATE_VISUALIZATION") + + @schemas.classproperty + def EXTEND_VISUALIZATION(cls): + return cls("EXTEND_VISUALIZATION") + + @schemas.classproperty + def HOWTO(cls): + return cls("HOWTO") + + @schemas.classproperty + def CHANGE_ANALYSIS(cls): + return cls("CHANGE_ANALYSIS") + + @schemas.classproperty + def ALERT(cls): + return cls("ALERT") + __annotations__ = { + "reasoning": reasoning, + "useCase": useCase, + } + + useCase: MetaOapg.properties.useCase + reasoning: MetaOapg.properties.reasoning + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["reasoning"]) -> MetaOapg.properties.reasoning: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["useCase"]) -> MetaOapg.properties.useCase: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["reasoning", "useCase", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["reasoning"]) -> MetaOapg.properties.reasoning: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["useCase"]) -> MetaOapg.properties.useCase: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["reasoning", "useCase", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + useCase: typing.Union[MetaOapg.properties.useCase, str, ], + reasoning: typing.Union[MetaOapg.properties.reasoning, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'RouteResult': + return super().__new__( + cls, + *_args, + useCase=useCase, + reasoning=reasoning, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/rsa_specification.py b/gooddata-api-client/gooddata_api_client/model/rsa_specification.py index 26adabffc..e34913213 100644 --- a/gooddata-api-client/gooddata_api_client/model/rsa_specification.py +++ b/gooddata-api-client/gooddata_api_client/model/rsa_specification.py @@ -70,6 +70,12 @@ class RsaSpecification(ModelNormal): } validations = { + ('kid',): { + 'max_length': 255, + 'regex': { + 'pattern': r'^[^.]', # noqa: E501 + }, + }, } @cached_property diff --git a/gooddata-api-client/gooddata_api_client/model/rsa_specification.pyi b/gooddata-api-client/gooddata_api_client/model/rsa_specification.pyi new file mode 100644 index 000000000..37f6a4bd2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/rsa_specification.pyi @@ -0,0 +1,226 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class RsaSpecification( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "kty", + "e", + "use", + "kid", + "alg", + "n", + } + + class properties: + + + class alg( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def RS256(cls): + return cls("RS256") + + @schemas.classproperty + def RS384(cls): + return cls("RS384") + + @schemas.classproperty + def RS512(cls): + return cls("RS512") + e = schemas.StrSchema + + + class kid( + schemas.StrSchema + ): + pass + + + class kty( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def RSA(cls): + return cls("RSA") + n = schemas.StrSchema + + + class use( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SIG(cls): + return cls("sig") + + + class x5c( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'x5c': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + x5t = schemas.StrSchema + __annotations__ = { + "alg": alg, + "e": e, + "kid": kid, + "kty": kty, + "n": n, + "use": use, + "x5c": x5c, + "x5t": x5t, + } + + kty: MetaOapg.properties.kty + e: MetaOapg.properties.e + use: MetaOapg.properties.use + kid: MetaOapg.properties.kid + alg: MetaOapg.properties.alg + n: MetaOapg.properties.n + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["alg"]) -> MetaOapg.properties.alg: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["e"]) -> MetaOapg.properties.e: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["kid"]) -> MetaOapg.properties.kid: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["kty"]) -> MetaOapg.properties.kty: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["n"]) -> MetaOapg.properties.n: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["use"]) -> MetaOapg.properties.use: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["x5c"]) -> MetaOapg.properties.x5c: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["x5t"]) -> MetaOapg.properties.x5t: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["alg", "e", "kid", "kty", "n", "use", "x5c", "x5t", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["alg"]) -> MetaOapg.properties.alg: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["e"]) -> MetaOapg.properties.e: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["kid"]) -> MetaOapg.properties.kid: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["kty"]) -> MetaOapg.properties.kty: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["n"]) -> MetaOapg.properties.n: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["use"]) -> MetaOapg.properties.use: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["x5c"]) -> typing.Union[MetaOapg.properties.x5c, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["x5t"]) -> typing.Union[MetaOapg.properties.x5t, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["alg", "e", "kid", "kty", "n", "use", "x5c", "x5t", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + kty: typing.Union[MetaOapg.properties.kty, str, ], + e: typing.Union[MetaOapg.properties.e, str, ], + use: typing.Union[MetaOapg.properties.use, str, ], + kid: typing.Union[MetaOapg.properties.kid, str, ], + alg: typing.Union[MetaOapg.properties.alg, str, ], + n: typing.Union[MetaOapg.properties.n, str, ], + x5c: typing.Union[MetaOapg.properties.x5c, list, tuple, schemas.Unset] = schemas.unset, + x5t: typing.Union[MetaOapg.properties.x5t, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'RsaSpecification': + return super().__new__( + cls, + *_args, + kty=kty, + e=e, + use=use, + kid=kid, + alg=alg, + n=n, + x5c=x5c, + x5t=x5t, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/rule_permission.pyi b/gooddata-api-client/gooddata_api_client/model/rule_permission.pyi new file mode 100644 index 000000000..97e37c380 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/rule_permission.pyi @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class RulePermission( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + List of rules + """ + + + class MetaOapg: + required = { + "type", + } + + class properties: + type = schemas.StrSchema + + + class permissions( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['GrantedPermission']: + return GrantedPermission + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['GrantedPermission'], typing.List['GrantedPermission']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'permissions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'GrantedPermission': + return super().__getitem__(i) + __annotations__ = { + "type": type, + "permissions": permissions, + } + + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["type", "permissions", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> typing.Union[MetaOapg.properties.permissions, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["type", "permissions", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + permissions: typing.Union[MetaOapg.properties.permissions, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'RulePermission': + return super().__new__( + cls, + *_args, + type=type, + permissions=permissions, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.granted_permission import GrantedPermission diff --git a/gooddata-api-client/gooddata_api_client/model/run_service_command_request.py b/gooddata-api-client/gooddata_api_client/model/run_service_command_request.py new file mode 100644 index 000000000..eab5f6050 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/run_service_command_request.py @@ -0,0 +1,274 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_node import JsonNode + globals()['JsonNode'] = JsonNode + + +class RunServiceCommandRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'context': ({str: (str, none_type)}, none_type,), # noqa: E501 + 'payload': (JsonNode,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'context': 'context', # noqa: E501 + 'payload': 'payload', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RunServiceCommandRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + context ({str: (str, none_type)}, none_type): The context to pass to the command. [optional] # noqa: E501 + payload (JsonNode): [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 + """RunServiceCommandRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + context ({str: (str, none_type)}, none_type): The context to pass to the command. [optional] # noqa: E501 + payload (JsonNode): [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/run_service_command_request.pyi b/gooddata-api-client/gooddata_api_client/model/run_service_command_request.pyi new file mode 100644 index 000000000..33b0cd768 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/run_service_command_request.pyi @@ -0,0 +1,147 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class RunServiceCommandRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Request to run an AI Lake Service Command + """ + + + class MetaOapg: + + class properties: + + + class context( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin + ): + + + class MetaOapg: + + + class additional_properties( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'additional_properties': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, None, str, ], + ) -> 'context': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + @staticmethod + def payload() -> typing.Type['JsonNode']: + return JsonNode + __annotations__ = { + "context": context, + "payload": payload, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["context"]) -> MetaOapg.properties.context: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["payload"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["context", "payload", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["context"]) -> typing.Union[MetaOapg.properties.context, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["payload"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["context", "payload", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + context: typing.Union[MetaOapg.properties.context, dict, frozendict.frozendict, None, schemas.Unset] = schemas.unset, + payload: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'RunServiceCommandRequest': + return super().__new__( + cls, + *_args, + context=context, + payload=payload, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/running_section.pyi b/gooddata-api-client/gooddata_api_client/model/running_section.pyi new file mode 100644 index 000000000..71f7086bf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/running_section.pyi @@ -0,0 +1,133 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class RunningSection( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Footer section of the slide + """ + + + class MetaOapg: + + class properties: + + + class left( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'left': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class right( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'right': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + __annotations__ = { + "left": left, + "right": right, + } + + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["left"]) -> MetaOapg.properties.left: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["right"]) -> MetaOapg.properties.right: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["left", "right", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["left"]) -> typing.Union[MetaOapg.properties.left, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["right"]) -> typing.Union[MetaOapg.properties.right, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["left", "right", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + left: typing.Union[MetaOapg.properties.left, None, str, schemas.Unset] = schemas.unset, + right: typing.Union[MetaOapg.properties.right, None, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'RunningSection': + return super().__new__( + cls, + *_args, + left=left, + right=right, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/saved_visualization.pyi b/gooddata-api-client/gooddata_api_client/model/saved_visualization.pyi new file mode 100644 index 000000000..76f5f96e4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/saved_visualization.pyi @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class SavedVisualization( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Created and saved visualization IDs. + """ + + + class MetaOapg: + required = { + "savedVisualizationId", + "createdVisualizationId", + } + + class properties: + createdVisualizationId = schemas.StrSchema + savedVisualizationId = schemas.StrSchema + __annotations__ = { + "createdVisualizationId": createdVisualizationId, + "savedVisualizationId": savedVisualizationId, + } + + savedVisualizationId: MetaOapg.properties.savedVisualizationId + createdVisualizationId: MetaOapg.properties.createdVisualizationId + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdVisualizationId"]) -> MetaOapg.properties.createdVisualizationId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["savedVisualizationId"]) -> MetaOapg.properties.savedVisualizationId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["createdVisualizationId", "savedVisualizationId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdVisualizationId"]) -> MetaOapg.properties.createdVisualizationId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["savedVisualizationId"]) -> MetaOapg.properties.savedVisualizationId: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["createdVisualizationId", "savedVisualizationId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + savedVisualizationId: typing.Union[MetaOapg.properties.savedVisualizationId, str, ], + createdVisualizationId: typing.Union[MetaOapg.properties.createdVisualizationId, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SavedVisualization': + return super().__new__( + cls, + *_args, + savedVisualizationId=savedVisualizationId, + createdVisualizationId=createdVisualizationId, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/search_knowledge_response_dto.py b/gooddata-api-client/gooddata_api_client/model/search_knowledge_response_dto.py new file mode 100644 index 000000000..30ca7572a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/search_knowledge_response_dto.py @@ -0,0 +1,284 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.knowledge_search_result_dto import KnowledgeSearchResultDto + from gooddata_api_client.model.search_statistics_dto import SearchStatisticsDto + globals()['KnowledgeSearchResultDto'] = KnowledgeSearchResultDto + globals()['SearchStatisticsDto'] = SearchStatisticsDto + + +class SearchKnowledgeResponseDto(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'results': ([KnowledgeSearchResultDto],), # noqa: E501 + 'statistics': (SearchStatisticsDto,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'results': 'results', # noqa: E501 + 'statistics': 'statistics', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, results, statistics, *args, **kwargs): # noqa: E501 + """SearchKnowledgeResponseDto - a model defined in OpenAPI + + Args: + results ([KnowledgeSearchResultDto]): + statistics (SearchStatisticsDto): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.results = results + self.statistics = statistics + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, results, statistics, *args, **kwargs): # noqa: E501 + """SearchKnowledgeResponseDto - a model defined in OpenAPI + + Args: + results ([KnowledgeSearchResultDto]): + statistics (SearchStatisticsDto): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.results = results + self.statistics = statistics + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-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_knowledge_response_dto.pyi b/gooddata-api-client/gooddata_api_client/model/search_knowledge_response_dto.pyi new file mode 100644 index 000000000..91555cc4d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/search_knowledge_response_dto.pyi @@ -0,0 +1,127 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class SearchKnowledgeResponseDto( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "results", + "statistics", + } + + class properties: + + + class results( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['KnowledgeSearchResultDto']: + return KnowledgeSearchResultDto + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['KnowledgeSearchResultDto'], typing.List['KnowledgeSearchResultDto']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'results': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'KnowledgeSearchResultDto': + return super().__getitem__(i) + + @staticmethod + def statistics() -> typing.Type['SearchStatisticsDto']: + return SearchStatisticsDto + __annotations__ = { + "results": results, + "statistics": statistics, + } + + results: MetaOapg.properties.results + statistics: 'SearchStatisticsDto' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["results"]) -> MetaOapg.properties.results: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["statistics"]) -> 'SearchStatisticsDto': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["results", "statistics", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["results"]) -> MetaOapg.properties.results: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["statistics"]) -> 'SearchStatisticsDto': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["results", "statistics", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + results: typing.Union[MetaOapg.properties.results, list, tuple, ], + statistics: 'SearchStatisticsDto', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SearchKnowledgeResponseDto': + return super().__new__( + cls, + *_args, + results=results, + statistics=statistics, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.knowledge_search_result_dto import KnowledgeSearchResultDto +from gooddata_api_client.model.search_statistics_dto import SearchStatisticsDto diff --git a/gooddata-api-client/gooddata_api_client/model/search_relationship_object.pyi b/gooddata-api-client/gooddata_api_client/model/search_relationship_object.pyi new file mode 100644 index 000000000..af6ecefa6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/search_relationship_object.pyi @@ -0,0 +1,168 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class SearchRelationshipObject( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "targetObjectTitle", + "sourceObjectType", + "targetObjectId", + "sourceWorkspaceId", + "targetWorkspaceId", + "sourceObjectId", + "sourceObjectTitle", + "targetObjectType", + } + + class properties: + sourceObjectId = schemas.StrSchema + sourceObjectTitle = schemas.StrSchema + sourceObjectType = schemas.StrSchema + sourceWorkspaceId = schemas.StrSchema + targetObjectId = schemas.StrSchema + targetObjectTitle = schemas.StrSchema + targetObjectType = schemas.StrSchema + targetWorkspaceId = schemas.StrSchema + __annotations__ = { + "sourceObjectId": sourceObjectId, + "sourceObjectTitle": sourceObjectTitle, + "sourceObjectType": sourceObjectType, + "sourceWorkspaceId": sourceWorkspaceId, + "targetObjectId": targetObjectId, + "targetObjectTitle": targetObjectTitle, + "targetObjectType": targetObjectType, + "targetWorkspaceId": targetWorkspaceId, + } + + targetObjectTitle: MetaOapg.properties.targetObjectTitle + sourceObjectType: MetaOapg.properties.sourceObjectType + targetObjectId: MetaOapg.properties.targetObjectId + sourceWorkspaceId: MetaOapg.properties.sourceWorkspaceId + targetWorkspaceId: MetaOapg.properties.targetWorkspaceId + sourceObjectId: MetaOapg.properties.sourceObjectId + sourceObjectTitle: MetaOapg.properties.sourceObjectTitle + targetObjectType: MetaOapg.properties.targetObjectType + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sourceObjectId"]) -> MetaOapg.properties.sourceObjectId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sourceObjectTitle"]) -> MetaOapg.properties.sourceObjectTitle: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sourceObjectType"]) -> MetaOapg.properties.sourceObjectType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sourceWorkspaceId"]) -> MetaOapg.properties.sourceWorkspaceId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["targetObjectId"]) -> MetaOapg.properties.targetObjectId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["targetObjectTitle"]) -> MetaOapg.properties.targetObjectTitle: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["targetObjectType"]) -> MetaOapg.properties.targetObjectType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["targetWorkspaceId"]) -> MetaOapg.properties.targetWorkspaceId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["sourceObjectId", "sourceObjectTitle", "sourceObjectType", "sourceWorkspaceId", "targetObjectId", "targetObjectTitle", "targetObjectType", "targetWorkspaceId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sourceObjectId"]) -> MetaOapg.properties.sourceObjectId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sourceObjectTitle"]) -> MetaOapg.properties.sourceObjectTitle: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sourceObjectType"]) -> MetaOapg.properties.sourceObjectType: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sourceWorkspaceId"]) -> MetaOapg.properties.sourceWorkspaceId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["targetObjectId"]) -> MetaOapg.properties.targetObjectId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["targetObjectTitle"]) -> MetaOapg.properties.targetObjectTitle: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["targetObjectType"]) -> MetaOapg.properties.targetObjectType: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["targetWorkspaceId"]) -> MetaOapg.properties.targetWorkspaceId: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["sourceObjectId", "sourceObjectTitle", "sourceObjectType", "sourceWorkspaceId", "targetObjectId", "targetObjectTitle", "targetObjectType", "targetWorkspaceId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + targetObjectTitle: typing.Union[MetaOapg.properties.targetObjectTitle, str, ], + sourceObjectType: typing.Union[MetaOapg.properties.sourceObjectType, str, ], + targetObjectId: typing.Union[MetaOapg.properties.targetObjectId, str, ], + sourceWorkspaceId: typing.Union[MetaOapg.properties.sourceWorkspaceId, str, ], + targetWorkspaceId: typing.Union[MetaOapg.properties.targetWorkspaceId, str, ], + sourceObjectId: typing.Union[MetaOapg.properties.sourceObjectId, str, ], + sourceObjectTitle: typing.Union[MetaOapg.properties.sourceObjectTitle, str, ], + targetObjectType: typing.Union[MetaOapg.properties.targetObjectType, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SearchRelationshipObject': + return super().__new__( + cls, + *_args, + targetObjectTitle=targetObjectTitle, + sourceObjectType=sourceObjectType, + targetObjectId=targetObjectId, + sourceWorkspaceId=sourceWorkspaceId, + targetWorkspaceId=targetWorkspaceId, + sourceObjectId=sourceObjectId, + sourceObjectTitle=sourceObjectTitle, + targetObjectType=targetObjectType, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/search_request.pyi b/gooddata-api-client/gooddata_api_client/model/search_request.pyi new file mode 100644 index 000000000..b0a1852a9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/search_request.pyi @@ -0,0 +1,319 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class SearchRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "question", + } + + class properties: + + + class question( + schemas.StrSchema + ): + pass + + + class allowedRelationshipTypes( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AllowedRelationshipType']: + return AllowedRelationshipType + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AllowedRelationshipType'], typing.List['AllowedRelationshipType']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'allowedRelationshipTypes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AllowedRelationshipType': + return super().__getitem__(i) + deepSearch = schemas.BoolSchema + enableHybridSearch = schemas.BoolSchema + + + class excludeTags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'excludeTags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + includeHidden = schemas.BoolSchema + + + class includeTags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'includeTags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + limit = schemas.Int32Schema + + + class objectTypes( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ATTRIBUTE(cls): + return cls("attribute") + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def FACT(cls): + return cls("fact") + + @schemas.classproperty + def LABEL(cls): + return cls("label") + + @schemas.classproperty + def DATE(cls): + return cls("date") + + @schemas.classproperty + def DATASET(cls): + return cls("dataset") + + @schemas.classproperty + def VISUALIZATION(cls): + return cls("visualization") + + @schemas.classproperty + def DASHBOARD(cls): + return cls("dashboard") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'objectTypes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + relevantScoreThreshold = schemas.Float64Schema + titleToDescriptorRatio = schemas.Float64Schema + __annotations__ = { + "question": question, + "allowedRelationshipTypes": allowedRelationshipTypes, + "deepSearch": deepSearch, + "enableHybridSearch": enableHybridSearch, + "excludeTags": excludeTags, + "includeHidden": includeHidden, + "includeTags": includeTags, + "limit": limit, + "objectTypes": objectTypes, + "relevantScoreThreshold": relevantScoreThreshold, + "titleToDescriptorRatio": titleToDescriptorRatio, + } + + question: MetaOapg.properties.question + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["question"]) -> MetaOapg.properties.question: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["allowedRelationshipTypes"]) -> MetaOapg.properties.allowedRelationshipTypes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["deepSearch"]) -> MetaOapg.properties.deepSearch: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["enableHybridSearch"]) -> MetaOapg.properties.enableHybridSearch: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["excludeTags"]) -> MetaOapg.properties.excludeTags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["includeHidden"]) -> MetaOapg.properties.includeHidden: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["includeTags"]) -> MetaOapg.properties.includeTags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["limit"]) -> MetaOapg.properties.limit: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["objectTypes"]) -> MetaOapg.properties.objectTypes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relevantScoreThreshold"]) -> MetaOapg.properties.relevantScoreThreshold: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["titleToDescriptorRatio"]) -> MetaOapg.properties.titleToDescriptorRatio: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["question", "allowedRelationshipTypes", "deepSearch", "enableHybridSearch", "excludeTags", "includeHidden", "includeTags", "limit", "objectTypes", "relevantScoreThreshold", "titleToDescriptorRatio", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["question"]) -> MetaOapg.properties.question: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["allowedRelationshipTypes"]) -> typing.Union[MetaOapg.properties.allowedRelationshipTypes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["deepSearch"]) -> typing.Union[MetaOapg.properties.deepSearch, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["enableHybridSearch"]) -> typing.Union[MetaOapg.properties.enableHybridSearch, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["excludeTags"]) -> typing.Union[MetaOapg.properties.excludeTags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["includeHidden"]) -> typing.Union[MetaOapg.properties.includeHidden, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["includeTags"]) -> typing.Union[MetaOapg.properties.includeTags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["limit"]) -> typing.Union[MetaOapg.properties.limit, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["objectTypes"]) -> typing.Union[MetaOapg.properties.objectTypes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relevantScoreThreshold"]) -> typing.Union[MetaOapg.properties.relevantScoreThreshold, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["titleToDescriptorRatio"]) -> typing.Union[MetaOapg.properties.titleToDescriptorRatio, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["question", "allowedRelationshipTypes", "deepSearch", "enableHybridSearch", "excludeTags", "includeHidden", "includeTags", "limit", "objectTypes", "relevantScoreThreshold", "titleToDescriptorRatio", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + question: typing.Union[MetaOapg.properties.question, str, ], + allowedRelationshipTypes: typing.Union[MetaOapg.properties.allowedRelationshipTypes, list, tuple, schemas.Unset] = schemas.unset, + deepSearch: typing.Union[MetaOapg.properties.deepSearch, bool, schemas.Unset] = schemas.unset, + enableHybridSearch: typing.Union[MetaOapg.properties.enableHybridSearch, bool, schemas.Unset] = schemas.unset, + excludeTags: typing.Union[MetaOapg.properties.excludeTags, list, tuple, schemas.Unset] = schemas.unset, + includeHidden: typing.Union[MetaOapg.properties.includeHidden, bool, schemas.Unset] = schemas.unset, + includeTags: typing.Union[MetaOapg.properties.includeTags, list, tuple, schemas.Unset] = schemas.unset, + limit: typing.Union[MetaOapg.properties.limit, decimal.Decimal, int, schemas.Unset] = schemas.unset, + objectTypes: typing.Union[MetaOapg.properties.objectTypes, list, tuple, schemas.Unset] = schemas.unset, + relevantScoreThreshold: typing.Union[MetaOapg.properties.relevantScoreThreshold, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + titleToDescriptorRatio: typing.Union[MetaOapg.properties.titleToDescriptorRatio, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SearchRequest': + return super().__new__( + cls, + *_args, + question=question, + allowedRelationshipTypes=allowedRelationshipTypes, + deepSearch=deepSearch, + enableHybridSearch=enableHybridSearch, + excludeTags=excludeTags, + includeHidden=includeHidden, + includeTags=includeTags, + limit=limit, + objectTypes=objectTypes, + relevantScoreThreshold=relevantScoreThreshold, + titleToDescriptorRatio=titleToDescriptorRatio, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.allowed_relationship_type import AllowedRelationshipType diff --git a/gooddata-api-client/gooddata_api_client/model/search_result.pyi b/gooddata-api-client/gooddata_api_client/model/search_result.pyi new file mode 100644 index 000000000..acddffbf1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/search_result.pyi @@ -0,0 +1,161 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class SearchResult( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "relationships", + "reasoning", + "results", + } + + class properties: + reasoning = schemas.StrSchema + + + class relationships( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['SearchRelationshipObject']: + return SearchRelationshipObject + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['SearchRelationshipObject'], typing.List['SearchRelationshipObject']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'relationships': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'SearchRelationshipObject': + return super().__getitem__(i) + + + class results( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['SearchResultObject']: + return SearchResultObject + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['SearchResultObject'], typing.List['SearchResultObject']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'results': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'SearchResultObject': + return super().__getitem__(i) + __annotations__ = { + "reasoning": reasoning, + "relationships": relationships, + "results": results, + } + + relationships: MetaOapg.properties.relationships + reasoning: MetaOapg.properties.reasoning + results: MetaOapg.properties.results + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["reasoning"]) -> MetaOapg.properties.reasoning: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["results"]) -> MetaOapg.properties.results: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["reasoning", "relationships", "results", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["reasoning"]) -> MetaOapg.properties.reasoning: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["relationships"]) -> MetaOapg.properties.relationships: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["results"]) -> MetaOapg.properties.results: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["reasoning", "relationships", "results", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + relationships: typing.Union[MetaOapg.properties.relationships, list, tuple, ], + reasoning: typing.Union[MetaOapg.properties.reasoning, str, ], + results: typing.Union[MetaOapg.properties.results, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SearchResult': + return super().__new__( + cls, + *_args, + relationships=relationships, + reasoning=reasoning, + results=results, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.search_relationship_object import SearchRelationshipObject +from gooddata_api_client.model.search_result_object import SearchResultObject diff --git a/gooddata-api-client/gooddata_api_client/model/search_result_object.pyi b/gooddata-api-client/gooddata_api_client/model/search_result_object.pyi new file mode 100644 index 000000000..b93bdec17 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/search_result_object.pyi @@ -0,0 +1,242 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class SearchResultObject( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "id", + "title", + "type", + "workspaceId", + } + + class properties: + id = schemas.StrSchema + title = schemas.StrSchema + type = schemas.StrSchema + workspaceId = schemas.StrSchema + createdAt = schemas.DateTimeSchema + description = schemas.StrSchema + isHidden = schemas.BoolSchema + modifiedAt = schemas.DateTimeSchema + score = schemas.Float32Schema + scoreDescriptor = schemas.Float32Schema + scoreExactMatch = schemas.Int32Schema + scoreTitle = schemas.Float32Schema + + + class tags( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tags': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + visualizationUrl = schemas.StrSchema + __annotations__ = { + "id": id, + "title": title, + "type": type, + "workspaceId": workspaceId, + "createdAt": createdAt, + "description": description, + "isHidden": isHidden, + "modifiedAt": modifiedAt, + "score": score, + "scoreDescriptor": scoreDescriptor, + "scoreExactMatch": scoreExactMatch, + "scoreTitle": scoreTitle, + "tags": tags, + "visualizationUrl": visualizationUrl, + } + + id: MetaOapg.properties.id + title: MetaOapg.properties.title + type: MetaOapg.properties.type + workspaceId: MetaOapg.properties.workspaceId + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workspaceId"]) -> MetaOapg.properties.workspaceId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["createdAt"]) -> MetaOapg.properties.createdAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["description"]) -> MetaOapg.properties.description: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isHidden"]) -> MetaOapg.properties.isHidden: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modifiedAt"]) -> MetaOapg.properties.modifiedAt: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["score"]) -> MetaOapg.properties.score: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["scoreDescriptor"]) -> MetaOapg.properties.scoreDescriptor: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["scoreExactMatch"]) -> MetaOapg.properties.scoreExactMatch: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["scoreTitle"]) -> MetaOapg.properties.scoreTitle: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tags"]) -> MetaOapg.properties.tags: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualizationUrl"]) -> MetaOapg.properties.visualizationUrl: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "title", "type", "workspaceId", "createdAt", "description", "isHidden", "modifiedAt", "score", "scoreDescriptor", "scoreExactMatch", "scoreTitle", "tags", "visualizationUrl", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workspaceId"]) -> MetaOapg.properties.workspaceId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["createdAt"]) -> typing.Union[MetaOapg.properties.createdAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["description"]) -> typing.Union[MetaOapg.properties.description, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isHidden"]) -> typing.Union[MetaOapg.properties.isHidden, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modifiedAt"]) -> typing.Union[MetaOapg.properties.modifiedAt, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["score"]) -> typing.Union[MetaOapg.properties.score, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["scoreDescriptor"]) -> typing.Union[MetaOapg.properties.scoreDescriptor, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["scoreExactMatch"]) -> typing.Union[MetaOapg.properties.scoreExactMatch, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["scoreTitle"]) -> typing.Union[MetaOapg.properties.scoreTitle, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tags"]) -> typing.Union[MetaOapg.properties.tags, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualizationUrl"]) -> typing.Union[MetaOapg.properties.visualizationUrl, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "title", "type", "workspaceId", "createdAt", "description", "isHidden", "modifiedAt", "score", "scoreDescriptor", "scoreExactMatch", "scoreTitle", "tags", "visualizationUrl", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + title: typing.Union[MetaOapg.properties.title, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + workspaceId: typing.Union[MetaOapg.properties.workspaceId, str, ], + createdAt: typing.Union[MetaOapg.properties.createdAt, str, datetime, schemas.Unset] = schemas.unset, + description: typing.Union[MetaOapg.properties.description, str, schemas.Unset] = schemas.unset, + isHidden: typing.Union[MetaOapg.properties.isHidden, bool, schemas.Unset] = schemas.unset, + modifiedAt: typing.Union[MetaOapg.properties.modifiedAt, str, datetime, schemas.Unset] = schemas.unset, + score: typing.Union[MetaOapg.properties.score, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + scoreDescriptor: typing.Union[MetaOapg.properties.scoreDescriptor, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + scoreExactMatch: typing.Union[MetaOapg.properties.scoreExactMatch, decimal.Decimal, int, schemas.Unset] = schemas.unset, + scoreTitle: typing.Union[MetaOapg.properties.scoreTitle, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + tags: typing.Union[MetaOapg.properties.tags, list, tuple, schemas.Unset] = schemas.unset, + visualizationUrl: typing.Union[MetaOapg.properties.visualizationUrl, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SearchResultObject': + return super().__new__( + cls, + *_args, + id=id, + title=title, + type=type, + workspaceId=workspaceId, + createdAt=createdAt, + description=description, + isHidden=isHidden, + modifiedAt=modifiedAt, + score=score, + scoreDescriptor=scoreDescriptor, + scoreExactMatch=scoreExactMatch, + scoreTitle=scoreTitle, + tags=tags, + visualizationUrl=visualizationUrl, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/search_statistics_dto.py b/gooddata-api-client/gooddata_api_client/model/search_statistics_dto.py new file mode 100644 index 000000000..4a36c3d12 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/search_statistics_dto.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class SearchStatisticsDto(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'average_similarity_score': (float,), # noqa: E501 + 'total_results': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'average_similarity_score': 'averageSimilarityScore', # noqa: E501 + 'total_results': 'totalResults', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, average_similarity_score, total_results, *args, **kwargs): # noqa: E501 + """SearchStatisticsDto - a model defined in OpenAPI + + Args: + average_similarity_score (float): + total_results (int): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.average_similarity_score = average_similarity_score + self.total_results = total_results + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, average_similarity_score, total_results, *args, **kwargs): # noqa: E501 + """SearchStatisticsDto - a model defined in OpenAPI + + Args: + average_similarity_score (float): + total_results (int): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.average_similarity_score = average_similarity_score + self.total_results = total_results + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-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_statistics_dto.pyi b/gooddata-api-client/gooddata_api_client/model/search_statistics_dto.pyi new file mode 100644 index 000000000..ca4b51f18 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/search_statistics_dto.pyi @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class SearchStatisticsDto( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "totalResults", + "averageSimilarityScore", + } + + class properties: + averageSimilarityScore = schemas.Float32Schema + totalResults = schemas.Int32Schema + __annotations__ = { + "averageSimilarityScore": averageSimilarityScore, + "totalResults": totalResults, + } + + totalResults: MetaOapg.properties.totalResults + averageSimilarityScore: MetaOapg.properties.averageSimilarityScore + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["averageSimilarityScore"]) -> MetaOapg.properties.averageSimilarityScore: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["totalResults"]) -> MetaOapg.properties.totalResults: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["averageSimilarityScore", "totalResults", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["averageSimilarityScore"]) -> MetaOapg.properties.averageSimilarityScore: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["totalResults"]) -> MetaOapg.properties.totalResults: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["averageSimilarityScore", "totalResults", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + totalResults: typing.Union[MetaOapg.properties.totalResults, decimal.Decimal, int, ], + averageSimilarityScore: typing.Union[MetaOapg.properties.averageSimilarityScore, decimal.Decimal, int, float, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SearchStatisticsDto': + return super().__new__( + cls, + *_args, + totalResults=totalResults, + averageSimilarityScore=averageSimilarityScore, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/section_slide_template.pyi b/gooddata-api-client/gooddata_api_client/model/section_slide_template.pyi new file mode 100644 index 000000000..8d91bc2d0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/section_slide_template.pyi @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class SectionSlideTemplate( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Settings for section slide. + """ + + + class MetaOapg: + + class properties: + backgroundImage = schemas.BoolSchema + + @staticmethod + def footer() -> typing.Type['RunningSection']: + return RunningSection + + @staticmethod + def header() -> typing.Type['RunningSection']: + return RunningSection + __annotations__ = { + "backgroundImage": backgroundImage, + "footer": footer, + "header": header, + } + + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["backgroundImage"]) -> MetaOapg.properties.backgroundImage: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["footer"]) -> 'RunningSection': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["header"]) -> 'RunningSection': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["backgroundImage", "footer", "header", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["backgroundImage"]) -> typing.Union[MetaOapg.properties.backgroundImage, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["footer"]) -> typing.Union['RunningSection', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["header"]) -> typing.Union['RunningSection', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["backgroundImage", "footer", "header", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + backgroundImage: typing.Union[MetaOapg.properties.backgroundImage, bool, schemas.Unset] = schemas.unset, + footer: typing.Union['RunningSection', schemas.Unset] = schemas.unset, + header: typing.Union['RunningSection', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SectionSlideTemplate': + return super().__new__( + cls, + *_args, + backgroundImage=backgroundImage, + footer=footer, + header=header, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.running_section import RunningSection diff --git a/gooddata-api-client/gooddata_api_client/model/service_info.py b/gooddata-api-client/gooddata_api_client/model/service_info.py new file mode 100644 index 000000000..c53f58fc6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/service_info.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class ServiceInfo(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'service_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'service_id': 'serviceId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, service_id, *args, **kwargs): # noqa: E501 + """ServiceInfo - a model defined in OpenAPI + + Args: + name (str): Human-readable name of the service + service_id (str): Internal identifier for the service configuration (UUID) + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.service_id = service_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, name, service_id, *args, **kwargs): # noqa: E501 + """ServiceInfo - a model defined in OpenAPI + + Args: + name (str): Human-readable name of the service + service_id (str): Internal identifier for the service configuration (UUID) + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.service_id = service_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/service_info.pyi b/gooddata-api-client/gooddata_api_client/model/service_info.pyi new file mode 100644 index 000000000..fd40cc93a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/service_info.pyi @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ServiceInfo( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Non-sensitive metadata for an AI Lake pipeline + """ + + + class MetaOapg: + required = { + "name", + "serviceId", + } + + class properties: + name = schemas.StrSchema + serviceId = schemas.StrSchema + __annotations__ = { + "name": name, + "serviceId": serviceId, + } + + name: MetaOapg.properties.name + serviceId: MetaOapg.properties.serviceId + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["serviceId"]) -> MetaOapg.properties.serviceId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["name", "serviceId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["serviceId"]) -> MetaOapg.properties.serviceId: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["name", "serviceId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + name: typing.Union[MetaOapg.properties.name, str, ], + serviceId: typing.Union[MetaOapg.properties.serviceId, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ServiceInfo': + return super().__new__( + cls, + *_args, + name=name, + serviceId=serviceId, + _configuration=_configuration, + **kwargs, + ) 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 new file mode 100644 index 000000000..2d9637ae2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/set_certification_request.py @@ -0,0 +1,293 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class SetCertificationRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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',): { + 'METRIC': "metric", + 'VISUALIZATIONOBJECT': "visualizationObject", + 'ANALYTICALDASHBOARD': "analyticalDashboard", + }, + ('status',): { + 'None': None, + 'CERTIFIED': "CERTIFIED", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'message': (str, none_type,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'message': 'message', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 + """SetCertificationRequest - a model defined in OpenAPI + + Args: + id (str): ID of the entity. + type (str): Type of the entity. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + message (str, none_type): Optional message associated with the certification.. [optional] # noqa: E501 + status (str, none_type): Certification status of the entity.. [optional] if omitted the server will use the default value of "CERTIFIED" # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, type, *args, **kwargs): # noqa: E501 + """SetCertificationRequest - a model defined in OpenAPI + + Args: + id (str): ID of the entity. + type (str): Type of the entity. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + message (str, none_type): Optional message associated with the certification.. [optional] # noqa: E501 + status (str, none_type): Certification status of the entity.. [optional] if omitted the server will use the default value of "CERTIFIED" # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.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/set_certification_request.pyi b/gooddata-api-client/gooddata_api_client/model/set_certification_request.pyi new file mode 100644 index 000000000..44c3ff3ab --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/set_certification_request.pyi @@ -0,0 +1,184 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class SetCertificationRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Request to set or clear the certification of a workspace entity. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def VISUALIZATION_OBJECT(cls): + return cls("visualizationObject") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + + class message( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'message': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class status( + schemas.EnumBase, + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + enum_value_to_name = { + "CERTIFIED": "CERTIFIED", + } + + @schemas.classproperty + def CERTIFIED(cls): + return cls("CERTIFIED") + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'status': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + __annotations__ = { + "id": id, + "type": type, + "message": message, + "status": status, + } + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["message"]) -> MetaOapg.properties.message: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", "message", "status", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["message"]) -> typing.Union[MetaOapg.properties.message, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["status"]) -> typing.Union[MetaOapg.properties.status, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", "message", "status", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + type: typing.Union[MetaOapg.properties.type, str, ], + message: typing.Union[MetaOapg.properties.message, None, str, schemas.Unset] = schemas.unset, + status: typing.Union[MetaOapg.properties.status, None, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SetCertificationRequest': + return super().__new__( + cls, + *_args, + id=id, + type=type, + message=message, + status=status, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/skeleton.pyi b/gooddata-api-client/gooddata_api_client/model/skeleton.pyi new file mode 100644 index 000000000..b62985882 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/skeleton.pyi @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Skeleton( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + + class content( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.DictSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'content': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + href = schemas.StrSchema + __annotations__ = { + "content": content, + "href": href, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["href"]) -> MetaOapg.properties.href: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["content", "href", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> typing.Union[MetaOapg.properties.content, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["href"]) -> typing.Union[MetaOapg.properties.href, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["content", "href", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + content: typing.Union[MetaOapg.properties.content, list, tuple, schemas.Unset] = schemas.unset, + href: typing.Union[MetaOapg.properties.href, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Skeleton': + return super().__new__( + cls, + *_args, + content=content, + href=href, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/slides_export_request.pyi b/gooddata-api-client/gooddata_api_client/model/slides_export_request.pyi new file mode 100644 index 000000000..3f31b7f45 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/slides_export_request.pyi @@ -0,0 +1,242 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class SlidesExportRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Export request object describing the export properties and metadata for slides exports. + """ + + + class MetaOapg: + required = { + "fileName", + "format", + } + + class properties: + fileName = schemas.StrSchema + + + class format( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PDF(cls): + return cls("PDF") + + @schemas.classproperty + def PPTX(cls): + return cls("PPTX") + dashboardId = schemas.StrSchema + + @staticmethod + def metadata() -> typing.Type['JsonNode']: + return JsonNode + + + class templateId( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'templateId': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class visualizationIds( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.StrSchema + ): + pass + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visualizationIds': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class widgetIds( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.StrSchema + ): + pass + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'widgetIds': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "fileName": fileName, + "format": format, + "dashboardId": dashboardId, + "metadata": metadata, + "templateId": templateId, + "visualizationIds": visualizationIds, + "widgetIds": widgetIds, + } + + fileName: MetaOapg.properties.fileName + format: MetaOapg.properties.format + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardId"]) -> MetaOapg.properties.dashboardId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metadata"]) -> 'JsonNode': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["templateId"]) -> MetaOapg.properties.templateId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualizationIds"]) -> MetaOapg.properties.visualizationIds: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["widgetIds"]) -> MetaOapg.properties.widgetIds: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["fileName", "format", "dashboardId", "metadata", "templateId", "visualizationIds", "widgetIds", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["format"]) -> MetaOapg.properties.format: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardId"]) -> typing.Union[MetaOapg.properties.dashboardId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metadata"]) -> typing.Union['JsonNode', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["templateId"]) -> typing.Union[MetaOapg.properties.templateId, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualizationIds"]) -> typing.Union[MetaOapg.properties.visualizationIds, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["widgetIds"]) -> typing.Union[MetaOapg.properties.widgetIds, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["fileName", "format", "dashboardId", "metadata", "templateId", "visualizationIds", "widgetIds", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + fileName: typing.Union[MetaOapg.properties.fileName, str, ], + format: typing.Union[MetaOapg.properties.format, str, ], + dashboardId: typing.Union[MetaOapg.properties.dashboardId, str, schemas.Unset] = schemas.unset, + metadata: typing.Union['JsonNode', schemas.Unset] = schemas.unset, + templateId: typing.Union[MetaOapg.properties.templateId, None, str, schemas.Unset] = schemas.unset, + visualizationIds: typing.Union[MetaOapg.properties.visualizationIds, list, tuple, schemas.Unset] = schemas.unset, + widgetIds: typing.Union[MetaOapg.properties.widgetIds, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SlidesExportRequest': + return super().__new__( + cls, + *_args, + fileName=fileName, + format=format, + dashboardId=dashboardId, + metadata=metadata, + templateId=templateId, + visualizationIds=visualizationIds, + widgetIds=widgetIds, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.json_node import JsonNode diff --git a/gooddata-api-client/gooddata_api_client/model/smart_function_response.pyi b/gooddata-api-client/gooddata_api_client/model/smart_function_response.pyi new file mode 100644 index 000000000..69fb950e6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/smart_function_response.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class SmartFunctionResponse( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "links", + } + + class properties: + + @staticmethod + def links() -> typing.Type['ExecutionLinks']: + return ExecutionLinks + __annotations__ = { + "links": links, + } + + links: 'ExecutionLinks' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["links"]) -> 'ExecutionLinks': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["links", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["links"]) -> 'ExecutionLinks': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["links", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + links: 'ExecutionLinks', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SmartFunctionResponse': + return super().__new__( + cls, + *_args, + links=links, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.execution_links import ExecutionLinks diff --git a/gooddata-api-client/gooddata_api_client/model/smtp.pyi b/gooddata-api-client/gooddata_api_client/model/smtp.pyi new file mode 100644 index 000000000..770de42e1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/smtp.pyi @@ -0,0 +1,332 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Smtp( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update + """ + + + class MetaOapg: + required = { + "type", + } + + class properties: + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SMTP(cls): + return cls("SMTP") + fromEmail = schemas.StrSchema + fromEmailName = schemas.StrSchema + host = schemas.StrSchema + password = schemas.StrSchema + + + class port( + schemas.EnumBase, + schemas.Int32Schema + ): + + @schemas.classproperty + def POSITIVE_25(cls): + return cls(25) + + @schemas.classproperty + def POSITIVE_465(cls): + return cls(465) + + @schemas.classproperty + def POSITIVE_587(cls): + return cls(587) + + @schemas.classproperty + def POSITIVE_2525(cls): + return cls(2525) + username = schemas.StrSchema + __annotations__ = { + "type": type, + "fromEmail": fromEmail, + "fromEmailName": fromEmailName, + "host": host, + "password": password, + "port": port, + "username": username, + } + + + class all_of_0( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + fromEmail = schemas.StrSchema + fromEmailName = schemas.StrSchema + host = schemas.StrSchema + password = schemas.StrSchema + + + class port( + schemas.EnumBase, + schemas.Int32Schema + ): + + @schemas.classproperty + def POSITIVE_25(cls): + return cls(25) + + @schemas.classproperty + def POSITIVE_465(cls): + return cls(465) + + @schemas.classproperty + def POSITIVE_587(cls): + return cls(587) + + @schemas.classproperty + def POSITIVE_2525(cls): + return cls(2525) + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def SMTP(cls): + return cls("SMTP") + username = schemas.StrSchema + __annotations__ = { + "fromEmail": fromEmail, + "fromEmailName": fromEmailName, + "host": host, + "password": password, + "port": port, + "type": type, + "username": username, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fromEmail"]) -> MetaOapg.properties.fromEmail: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fromEmailName"]) -> MetaOapg.properties.fromEmailName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["host"]) -> MetaOapg.properties.host: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["password"]) -> MetaOapg.properties.password: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["port"]) -> MetaOapg.properties.port: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["username"]) -> MetaOapg.properties.username: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["fromEmail", "fromEmailName", "host", "password", "port", "type", "username", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fromEmail"]) -> typing.Union[MetaOapg.properties.fromEmail, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fromEmailName"]) -> typing.Union[MetaOapg.properties.fromEmailName, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["host"]) -> typing.Union[MetaOapg.properties.host, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["password"]) -> typing.Union[MetaOapg.properties.password, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["port"]) -> typing.Union[MetaOapg.properties.port, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> typing.Union[MetaOapg.properties.type, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["username"]) -> typing.Union[MetaOapg.properties.username, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["fromEmail", "fromEmailName", "host", "password", "port", "type", "username", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + fromEmail: typing.Union[MetaOapg.properties.fromEmail, str, schemas.Unset] = schemas.unset, + fromEmailName: typing.Union[MetaOapg.properties.fromEmailName, str, schemas.Unset] = schemas.unset, + host: typing.Union[MetaOapg.properties.host, str, schemas.Unset] = schemas.unset, + password: typing.Union[MetaOapg.properties.password, str, schemas.Unset] = schemas.unset, + port: typing.Union[MetaOapg.properties.port, decimal.Decimal, int, schemas.Unset] = schemas.unset, + type: typing.Union[MetaOapg.properties.type, str, schemas.Unset] = schemas.unset, + username: typing.Union[MetaOapg.properties.username, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + fromEmail=fromEmail, + fromEmailName=fromEmailName, + host=host, + password=password, + port=port, + type=type, + username=username, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + ] + + + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fromEmail"]) -> MetaOapg.properties.fromEmail: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fromEmailName"]) -> MetaOapg.properties.fromEmailName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["host"]) -> MetaOapg.properties.host: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["password"]) -> MetaOapg.properties.password: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["port"]) -> MetaOapg.properties.port: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["username"]) -> MetaOapg.properties.username: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["type", "fromEmail", "fromEmailName", "host", "password", "port", "username", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fromEmail"]) -> typing.Union[MetaOapg.properties.fromEmail, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fromEmailName"]) -> typing.Union[MetaOapg.properties.fromEmailName, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["host"]) -> typing.Union[MetaOapg.properties.host, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["password"]) -> typing.Union[MetaOapg.properties.password, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["port"]) -> typing.Union[MetaOapg.properties.port, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["username"]) -> typing.Union[MetaOapg.properties.username, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["type", "fromEmail", "fromEmailName", "host", "password", "port", "username", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + fromEmail: typing.Union[MetaOapg.properties.fromEmail, str, schemas.Unset] = schemas.unset, + fromEmailName: typing.Union[MetaOapg.properties.fromEmailName, str, schemas.Unset] = schemas.unset, + host: typing.Union[MetaOapg.properties.host, str, schemas.Unset] = schemas.unset, + password: typing.Union[MetaOapg.properties.password, str, schemas.Unset] = schemas.unset, + port: typing.Union[MetaOapg.properties.port, decimal.Decimal, int, schemas.Unset] = schemas.unset, + username: typing.Union[MetaOapg.properties.username, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Smtp': + return super().__new__( + cls, + *_args, + type=type, + fromEmail=fromEmail, + fromEmailName=fromEmailName, + host=host, + password=password, + port=port, + username=username, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/sql_query.pyi b/gooddata-api-client/gooddata_api_client/model/sql_query.pyi new file mode 100644 index 000000000..6cc61f869 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/sql_query.pyi @@ -0,0 +1,124 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class SqlQuery( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "sql", + } + + + class all_of_1( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + sql = schemas.StrSchema + __annotations__ = { + "sql": sql, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["sql"]) -> MetaOapg.properties.sql: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["sql", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["sql"]) -> typing.Union[MetaOapg.properties.sql, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["sql", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + sql: typing.Union[MetaOapg.properties.sql, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + sql=sql, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + ColumnLocation, + cls.all_of_1, + ] + + + sql: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SqlQuery': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.column_location import ColumnLocation 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 cfcef8971..a78b6a3cb 100644 --- a/gooddata-api-client/gooddata_api_client/model/succeeded_operation.py +++ b/gooddata-api-client/gooddata_api_client/model/succeeded_operation.py @@ -31,15 +31,9 @@ def lazy_import(): - from gooddata_api_client.model.failed_operation import FailedOperation from gooddata_api_client.model.operation import Operation - from gooddata_api_client.model.pending_operation import PendingOperation - from gooddata_api_client.model.succeeded_operation import SucceededOperation from gooddata_api_client.model.succeeded_operation_all_of import SucceededOperationAllOf - globals()['FailedOperation'] = FailedOperation globals()['Operation'] = Operation - globals()['PendingOperation'] = PendingOperation - globals()['SucceededOperation'] = SucceededOperation globals()['SucceededOperationAllOf'] = SucceededOperationAllOf @@ -71,6 +65,7 @@ class SucceededOperation(ModelComposed): ('kind',): { 'PROVISION-DATABASE': "provision-database", 'DEPROVISION-DATABASE': "deprovision-database", + 'RUN-SERVICE-COMMAND': "run-service-command", }, } @@ -108,11 +103,7 @@ def openapi_types(): @cached_property def discriminator(): - lazy_import() val = { - 'failed': FailedOperation, - 'pending': PendingOperation, - 'succeeded': SucceededOperation, } if not val: return None @@ -135,7 +126,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Keyword 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. + 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. status (str): _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be @@ -242,7 +233,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Keyword 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. + 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. status (str): _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be diff --git a/gooddata-api-client/gooddata_api_client/model/succeeded_operation.pyi b/gooddata-api-client/gooddata_api_client/model/succeeded_operation.pyi new file mode 100644 index 000000000..4fc5a1d0f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/succeeded_operation.pyi @@ -0,0 +1,141 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class SucceededOperation( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Operation that has succeeded + """ + + + class MetaOapg: + required = { + "kind", + "id", + } + + @staticmethod + def discriminator(): + return { + 'status': { + 'failed': FailedOperation, + 'pending': PendingOperation, + 'succeeded': SucceededOperation, + } + } + + + class all_of_1( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + result = schemas.DictSchema + __annotations__ = { + "result": result, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["result"]) -> MetaOapg.properties.result: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["result", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["result"]) -> typing.Union[MetaOapg.properties.result, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["result", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + result: typing.Union[MetaOapg.properties.result, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + result=result, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + Operation, + cls.all_of_1, + ] + + + kind: schemas.AnyTypeSchema + id: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SucceededOperation': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.failed_operation import FailedOperation +from gooddata_api_client.model.operation import Operation +from gooddata_api_client.model.pending_operation import PendingOperation +from gooddata_api_client.model.succeeded_operation import SucceededOperation diff --git a/gooddata-api-client/gooddata_api_client/model/suggestion.pyi b/gooddata-api-client/gooddata_api_client/model/suggestion.pyi new file mode 100644 index 000000000..615c9adf2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/suggestion.pyi @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Suggestion( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + List of suggestions for next steps. Filled when no visualization was created, suggests alternatives. + """ + + + class MetaOapg: + required = { + "query", + "label", + } + + class properties: + label = schemas.StrSchema + query = schemas.StrSchema + __annotations__ = { + "label": label, + "query": query, + } + + query: MetaOapg.properties.query + label: MetaOapg.properties.label + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["label"]) -> MetaOapg.properties.label: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["query"]) -> MetaOapg.properties.query: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["label", "query", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["label"]) -> MetaOapg.properties.label: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["query"]) -> MetaOapg.properties.query: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["label", "query", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + query: typing.Union[MetaOapg.properties.query, str, ], + label: typing.Union[MetaOapg.properties.label, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Suggestion': + return super().__new__( + cls, + *_args, + query=query, + label=label, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/switch_identity_provider_request.pyi b/gooddata-api-client/gooddata_api_client/model/switch_identity_provider_request.pyi new file mode 100644 index 000000000..d9545c9bf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/switch_identity_provider_request.pyi @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class SwitchIdentityProviderRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "idpId", + } + + class properties: + idpId = schemas.StrSchema + __annotations__ = { + "idpId": idpId, + } + + idpId: MetaOapg.properties.idpId + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["idpId"]) -> MetaOapg.properties.idpId: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["idpId", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["idpId"]) -> MetaOapg.properties.idpId: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["idpId", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + idpId: typing.Union[MetaOapg.properties.idpId, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SwitchIdentityProviderRequest': + return super().__new__( + cls, + *_args, + idpId=idpId, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/table.pyi b/gooddata-api-client/gooddata_api_client/model/table.pyi new file mode 100644 index 000000000..9ad5099f7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/table.pyi @@ -0,0 +1,124 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Table( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "tableName", + } + + + class all_of_1( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + tableName = schemas.StrSchema + __annotations__ = { + "tableName": tableName, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tableName"]) -> MetaOapg.properties.tableName: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["tableName", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tableName"]) -> typing.Union[MetaOapg.properties.tableName, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["tableName", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + tableName: typing.Union[MetaOapg.properties.tableName, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + tableName=tableName, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + ColumnLocation, + cls.all_of_1, + ] + + + tableName: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Table': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.column_location import ColumnLocation diff --git a/gooddata-api-client/gooddata_api_client/model/table_override.pyi b/gooddata-api-client/gooddata_api_client/model/table_override.pyi new file mode 100644 index 000000000..65b8bf501 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/table_override.pyi @@ -0,0 +1,147 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class TableOverride( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Table override settings. + """ + + + class MetaOapg: + required = { + "path", + "columns", + } + + class properties: + + + class columns( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ColumnOverride']: + return ColumnOverride + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['ColumnOverride'], typing.List['ColumnOverride']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'columns': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ColumnOverride': + return super().__getitem__(i) + + + class path( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'path': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "columns": columns, + "path": path, + } + + path: MetaOapg.properties.path + columns: MetaOapg.properties.columns + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["path"]) -> MetaOapg.properties.path: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["columns", "path", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["columns"]) -> MetaOapg.properties.columns: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["path"]) -> MetaOapg.properties.path: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["columns", "path", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + path: typing.Union[MetaOapg.properties.path, list, tuple, ], + columns: typing.Union[MetaOapg.properties.columns, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'TableOverride': + return super().__new__( + cls, + *_args, + path=path, + columns=columns, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.column_override import ColumnOverride diff --git a/gooddata-api-client/gooddata_api_client/model/test_destination_request.pyi b/gooddata-api-client/gooddata_api_client/model/test_destination_request.pyi new file mode 100644 index 000000000..a93a75be9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/test_destination_request.pyi @@ -0,0 +1,166 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class TestDestinationRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Request body with notification channel destination to test. + """ + + + class MetaOapg: + required = { + "destination", + } + + class properties: + + + class destination( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + DefaultSmtp, + InPlatform, + Smtp, + Webhook, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'destination': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class externalRecipients( + schemas.ListBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneTupleMixin + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AutomationExternalRecipient']: + return AutomationExternalRecipient + + + def __new__( + cls, + *_args: typing.Union[list, tuple, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'externalRecipients': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + __annotations__ = { + "destination": destination, + "externalRecipients": externalRecipients, + } + + destination: MetaOapg.properties.destination + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["destination"]) -> MetaOapg.properties.destination: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["externalRecipients"]) -> MetaOapg.properties.externalRecipients: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["destination", "externalRecipients", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["destination"]) -> MetaOapg.properties.destination: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["externalRecipients"]) -> typing.Union[MetaOapg.properties.externalRecipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["destination", "externalRecipients", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + destination: typing.Union[MetaOapg.properties.destination, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + externalRecipients: typing.Union[MetaOapg.properties.externalRecipients, list, tuple, None, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'TestDestinationRequest': + return super().__new__( + cls, + *_args, + destination=destination, + externalRecipients=externalRecipients, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.automation_external_recipient import AutomationExternalRecipient +from gooddata_api_client.model.default_smtp import DefaultSmtp +from gooddata_api_client.model.in_platform import InPlatform +from gooddata_api_client.model.smtp import Smtp +from gooddata_api_client.model.webhook import Webhook diff --git a/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request.py b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request.py new file mode 100644 index 000000000..d1ebb7f5f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request.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.llm_model import LlmModel + from gooddata_api_client.model.test_llm_provider_definition_request_provider_config import TestLlmProviderDefinitionRequestProviderConfig + globals()['LlmModel'] = LlmModel + globals()['TestLlmProviderDefinitionRequestProviderConfig'] = TestLlmProviderDefinitionRequestProviderConfig + + +class TestLlmProviderDefinitionRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'provider_config': (TestLlmProviderDefinitionRequestProviderConfig,), # noqa: E501 + 'models': ([LlmModel],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'provider_config': 'providerConfig', # noqa: E501 + 'models': 'models', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, provider_config, *args, **kwargs): # noqa: E501 + """TestLlmProviderDefinitionRequest - a model defined in OpenAPI + + Args: + provider_config (TestLlmProviderDefinitionRequestProviderConfig): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + models ([LlmModel]): Models to test.. [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.provider_config = provider_config + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, provider_config, *args, **kwargs): # noqa: E501 + """TestLlmProviderDefinitionRequest - a model defined in OpenAPI + + Args: + provider_config (TestLlmProviderDefinitionRequestProviderConfig): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + models ([LlmModel]): Models to test.. [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.provider_config = provider_config + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request.pyi b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request.pyi new file mode 100644 index 000000000..5ff09dde9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request.pyi @@ -0,0 +1,161 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class TestLlmProviderDefinitionRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "providerConfig", + } + + class properties: + + + class providerConfig( + schemas.ComposedSchema, + ): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + AwsBedrockProviderConfig, + AzureFoundryProviderConfig, + OpenAIProviderConfig, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'providerConfig': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class models( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['LlmModel']: + return LlmModel + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['LlmModel'], typing.List['LlmModel']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'models': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'LlmModel': + return super().__getitem__(i) + __annotations__ = { + "providerConfig": providerConfig, + "models": models, + } + + providerConfig: MetaOapg.properties.providerConfig + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["providerConfig"]) -> MetaOapg.properties.providerConfig: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["models"]) -> MetaOapg.properties.models: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["providerConfig", "models", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["providerConfig"]) -> MetaOapg.properties.providerConfig: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["models"]) -> typing.Union[MetaOapg.properties.models, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["providerConfig", "models", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + providerConfig: typing.Union[MetaOapg.properties.providerConfig, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + models: typing.Union[MetaOapg.properties.models, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'TestLlmProviderDefinitionRequest': + return super().__new__( + cls, + *_args, + providerConfig=providerConfig, + models=models, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.aws_bedrock_provider_config import AwsBedrockProviderConfig +from gooddata_api_client.model.azure_foundry_provider_config import AzureFoundryProviderConfig +from gooddata_api_client.model.llm_model import LlmModel +from gooddata_api_client.model.open_ai_provider_config import OpenAIProviderConfig diff --git a/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request_provider_config.py b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request_provider_config.py new file mode 100644 index 000000000..e93080b2c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request_provider_config.py @@ -0,0 +1,363 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.aws_bedrock_provider_config import AwsBedrockProviderConfig + from gooddata_api_client.model.azure_foundry_provider_config import AzureFoundryProviderConfig + from gooddata_api_client.model.open_ai_provider_auth import OpenAiProviderAuth + from gooddata_api_client.model.open_ai_provider_config import OpenAIProviderConfig + globals()['AwsBedrockProviderConfig'] = AwsBedrockProviderConfig + globals()['AzureFoundryProviderConfig'] = AzureFoundryProviderConfig + globals()['OpenAIProviderConfig'] = OpenAIProviderConfig + globals()['OpenAiProviderAuth'] = OpenAiProviderAuth + + +class TestLlmProviderDefinitionRequestProviderConfig(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',): { + 'OPENAI': "OPENAI", + }, + } + + validations = { + ('base_url',): { + 'max_length': 255, + }, + ('organization',): { + 'max_length': 255, + }, + ('region',): { + 'max_length': 255, + }, + ('endpoint',): { + '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 { + 'base_url': (str, none_type,), # noqa: E501 + 'organization': (str, none_type,), # noqa: E501 + 'auth': (OpenAiProviderAuth,), # noqa: E501 + 'region': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'endpoint': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'base_url': 'baseUrl', # noqa: E501 + 'organization': 'organization', # noqa: E501 + 'auth': 'auth', # noqa: E501 + 'region': 'region', # noqa: E501 + 'type': 'type', # noqa: E501 + 'endpoint': 'endpoint', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TestLlmProviderDefinitionRequestProviderConfig - 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,) + base_url (str, none_type): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com" # noqa: E501 + organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 + auth (OpenAiProviderAuth): [optional] # noqa: E501 + region (str): AWS region for Bedrock.. [optional] # noqa: E501 + type (str): Provider type.. [optional] if omitted the server will use the default value of "OPENAI" # noqa: E501 + endpoint (str): Azure AI inference endpoint URL.. [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 + """TestLlmProviderDefinitionRequestProviderConfig - 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,) + base_url (str, none_type): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com" # noqa: E501 + organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 + auth (OpenAiProviderAuth): [optional] # noqa: E501 + region (str): AWS region for Bedrock.. [optional] # noqa: E501 + type (str): Provider type.. [optional] if omitted the server will use the default value of "OPENAI" # noqa: E501 + endpoint (str): Azure AI inference endpoint URL.. [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': [ + AwsBedrockProviderConfig, + AzureFoundryProviderConfig, + OpenAIProviderConfig, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/test_llm_provider_response.py b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_response.py new file mode 100644 index 000000000..88f1c262a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_response.py @@ -0,0 +1,288 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.model_test_result import ModelTestResult + globals()['ModelTestResult'] = ModelTestResult + + +class TestLlmProviderResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'model_results': ([ModelTestResult],), # noqa: E501 + 'provider_message': (str,), # noqa: E501 + 'provider_reachable': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'model_results': 'modelResults', # noqa: E501 + 'provider_message': 'providerMessage', # noqa: E501 + 'provider_reachable': 'providerReachable', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, model_results, provider_message, provider_reachable, *args, **kwargs): # noqa: E501 + """TestLlmProviderResponse - a model defined in OpenAPI + + Args: + model_results ([ModelTestResult]): Per-model test results. + provider_message (str): Message about the provider connectivity test. + provider_reachable (bool): Whether the LLM provider is reachable. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.model_results = model_results + self.provider_message = provider_message + self.provider_reachable = provider_reachable + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, model_results, provider_message, provider_reachable, *args, **kwargs): # noqa: E501 + """TestLlmProviderResponse - a model defined in OpenAPI + + Args: + model_results ([ModelTestResult]): Per-model test results. + provider_message (str): Message about the provider connectivity test. + provider_reachable (bool): Whether the LLM provider is reachable. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.model_results = model_results + self.provider_message = provider_message + self.provider_reachable = provider_reachable + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/test_llm_provider_response.pyi b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_response.pyi new file mode 100644 index 000000000..742e93655 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_response.pyi @@ -0,0 +1,135 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class TestLlmProviderResponse( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "modelResults", + "providerReachable", + "providerMessage", + } + + class properties: + + + class modelResults( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ModelTestResult']: + return ModelTestResult + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['ModelTestResult'], typing.List['ModelTestResult']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'modelResults': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ModelTestResult': + return super().__getitem__(i) + providerMessage = schemas.StrSchema + providerReachable = schemas.BoolSchema + __annotations__ = { + "modelResults": modelResults, + "providerMessage": providerMessage, + "providerReachable": providerReachable, + } + + modelResults: MetaOapg.properties.modelResults + providerReachable: MetaOapg.properties.providerReachable + providerMessage: MetaOapg.properties.providerMessage + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["modelResults"]) -> MetaOapg.properties.modelResults: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["providerMessage"]) -> MetaOapg.properties.providerMessage: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["providerReachable"]) -> MetaOapg.properties.providerReachable: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["modelResults", "providerMessage", "providerReachable", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["modelResults"]) -> MetaOapg.properties.modelResults: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["providerMessage"]) -> MetaOapg.properties.providerMessage: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["providerReachable"]) -> MetaOapg.properties.providerReachable: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["modelResults", "providerMessage", "providerReachable", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + modelResults: typing.Union[MetaOapg.properties.modelResults, list, tuple, ], + providerReachable: typing.Union[MetaOapg.properties.providerReachable, bool, ], + providerMessage: typing.Union[MetaOapg.properties.providerMessage, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'TestLlmProviderResponse': + return super().__new__( + cls, + *_args, + modelResults=modelResults, + providerReachable=providerReachable, + providerMessage=providerMessage, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.model_test_result import ModelTestResult diff --git a/gooddata-api-client/gooddata_api_client/model/test_notification.py b/gooddata-api-client/gooddata_api_client/model/test_notification.py index f96bb0540..c4155c21a 100644 --- a/gooddata-api-client/gooddata_api_client/model/test_notification.py +++ b/gooddata-api-client/gooddata_api_client/model/test_notification.py @@ -31,13 +31,9 @@ def lazy_import(): - from gooddata_api_client.model.automation_notification import AutomationNotification from gooddata_api_client.model.notification_content import NotificationContent - from gooddata_api_client.model.test_notification import TestNotification from gooddata_api_client.model.test_notification_all_of import TestNotificationAllOf - globals()['AutomationNotification'] = AutomationNotification globals()['NotificationContent'] = NotificationContent - globals()['TestNotification'] = TestNotification globals()['TestNotificationAllOf'] = TestNotificationAllOf @@ -100,10 +96,7 @@ def openapi_types(): @cached_property def discriminator(): - lazy_import() val = { - 'AUTOMATION': AutomationNotification, - 'TEST': TestNotification, } if not val: return None diff --git a/gooddata-api-client/gooddata_api_client/model/test_notification.pyi b/gooddata-api-client/gooddata_api_client/model/test_notification.pyi new file mode 100644 index 000000000..3acd522ba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/test_notification.pyi @@ -0,0 +1,135 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class TestNotification( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "message", + } + + @staticmethod + def discriminator(): + return { + 'type': { + 'AUTOMATION': AutomationNotification, + 'TEST': TestNotification, + } + } + + + class all_of_1( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + message = schemas.StrSchema + __annotations__ = { + "message": message, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["message"]) -> MetaOapg.properties.message: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["message", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["message"]) -> typing.Union[MetaOapg.properties.message, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["message", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + message: typing.Union[MetaOapg.properties.message, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_1': + return super().__new__( + cls, + *_args, + message=message, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + NotificationContent, + cls.all_of_1, + ] + + + message: schemas.AnyTypeSchema + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'TestNotification': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.automation_notification import AutomationNotification +from gooddata_api_client.model.notification_content import NotificationContent +from gooddata_api_client.model.test_notification import TestNotification diff --git a/gooddata-api-client/gooddata_api_client/model/thought.pyi b/gooddata-api-client/gooddata_api_client/model/thought.pyi new file mode 100644 index 000000000..f056c82b2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/thought.pyi @@ -0,0 +1,86 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Thought( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Detailed thoughts/messages within this step. + """ + + + class MetaOapg: + required = { + "text", + } + + class properties: + text = schemas.StrSchema + __annotations__ = { + "text": text, + } + + text: MetaOapg.properties.text + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["text"]) -> MetaOapg.properties.text: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["text", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["text"]) -> MetaOapg.properties.text: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["text", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + text: typing.Union[MetaOapg.properties.text, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Thought': + return super().__new__( + cls, + *_args, + text=text, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/trigger_automation_request.pyi b/gooddata-api-client/gooddata_api_client/model/trigger_automation_request.pyi new file mode 100644 index 000000000..ec9437262 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/trigger_automation_request.pyi @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class TriggerAutomationRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "automation", + } + + class properties: + + @staticmethod + def automation() -> typing.Type['AdHocAutomation']: + return AdHocAutomation + __annotations__ = { + "automation": automation, + } + + automation: 'AdHocAutomation' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["automation"]) -> 'AdHocAutomation': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["automation", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["automation"]) -> 'AdHocAutomation': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["automation", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + automation: 'AdHocAutomation', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'TriggerAutomationRequest': + return super().__new__( + cls, + *_args, + automation=automation, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.ad_hoc_automation import AdHocAutomation diff --git a/gooddata-api-client/gooddata_api_client/model/trigger_quality_issues_calculation_response.py b/gooddata-api-client/gooddata_api_client/model/trigger_quality_issues_calculation_response.py index 5a20d5906..8551cf53a 100644 --- a/gooddata-api-client/gooddata_api_client/model/trigger_quality_issues_calculation_response.py +++ b/gooddata-api-client/gooddata_api_client/model/trigger_quality_issues_calculation_response.py @@ -60,6 +60,7 @@ class TriggerQualityIssuesCalculationResponse(ModelNormal): 'RUNNING': "RUNNING", 'COMPLETED': "COMPLETED", 'FAILED': "FAILED", + 'CANCELLED': "CANCELLED", 'DISABLED': "DISABLED", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/trigger_quality_issues_calculation_response.pyi b/gooddata-api-client/gooddata_api_client/model/trigger_quality_issues_calculation_response.pyi new file mode 100644 index 000000000..9d68ea1ef --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/trigger_quality_issues_calculation_response.pyi @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class TriggerQualityIssuesCalculationResponse( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "processId", + "status", + } + + class properties: + processId = schemas.StrSchema + + + class status( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def RUNNING(cls): + return cls("RUNNING") + + @schemas.classproperty + def COMPLETED(cls): + return cls("COMPLETED") + + @schemas.classproperty + def FAILED(cls): + return cls("FAILED") + + @schemas.classproperty + def CANCELLED(cls): + return cls("CANCELLED") + + @schemas.classproperty + def DISABLED(cls): + return cls("DISABLED") + __annotations__ = { + "processId": processId, + "status": status, + } + + processId: MetaOapg.properties.processId + status: MetaOapg.properties.status + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["processId"]) -> MetaOapg.properties.processId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["processId", "status", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["processId"]) -> MetaOapg.properties.processId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["status"]) -> MetaOapg.properties.status: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["processId", "status", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + processId: typing.Union[MetaOapg.properties.processId, str, ], + status: typing.Union[MetaOapg.properties.status, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'TriggerQualityIssuesCalculationResponse': + return super().__new__( + cls, + *_args, + processId=processId, + status=status, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/upsert_knowledge_document_request_dto.py b/gooddata-api-client/gooddata_api_client/model/upsert_knowledge_document_request_dto.py new file mode 100644 index 000000000..1795c08e6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/upsert_knowledge_document_request_dto.py @@ -0,0 +1,288 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class UpsertKnowledgeDocumentRequestDto(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'content': (str,), # noqa: E501 + 'filename': (str,), # noqa: E501 + 'page_boundaries': ([int],), # noqa: E501 + 'scopes': ([str],), # noqa: E501 + 'title': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'filename': 'filename', # noqa: E501 + 'page_boundaries': 'pageBoundaries', # noqa: E501 + 'scopes': 'scopes', # noqa: E501 + 'title': 'title', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, filename, *args, **kwargs): # noqa: E501 + """UpsertKnowledgeDocumentRequestDto - a model defined in OpenAPI + + Args: + content (str): + filename (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,) + page_boundaries ([int]): [optional] # noqa: E501 + scopes ([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__,) + + self.content = content + self.filename = filename + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = 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, filename, *args, **kwargs): # noqa: E501 + """UpsertKnowledgeDocumentRequestDto - a model defined in OpenAPI + + Args: + content (str): + filename (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,) + page_boundaries ([int]): [optional] # noqa: E501 + scopes ([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__,) + + self.content = content + self.filename = filename + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/upsert_knowledge_document_request_dto.pyi b/gooddata-api-client/gooddata_api_client/model/upsert_knowledge_document_request_dto.pyi new file mode 100644 index 000000000..39be8856d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/upsert_knowledge_document_request_dto.pyi @@ -0,0 +1,170 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class UpsertKnowledgeDocumentRequestDto( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "filename", + "content", + } + + class properties: + content = schemas.StrSchema + filename = schemas.StrSchema + + + class pageBoundaries( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.Int32Schema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, decimal.Decimal, int, ]], typing.List[typing.Union[MetaOapg.items, decimal.Decimal, int, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'pageBoundaries': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class scopes( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'scopes': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + title = schemas.StrSchema + __annotations__ = { + "content": content, + "filename": filename, + "pageBoundaries": pageBoundaries, + "scopes": scopes, + "title": title, + } + + filename: MetaOapg.properties.filename + content: MetaOapg.properties.content + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filename"]) -> MetaOapg.properties.filename: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["pageBoundaries"]) -> MetaOapg.properties.pageBoundaries: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["scopes"]) -> MetaOapg.properties.scopes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["content", "filename", "pageBoundaries", "scopes", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["content"]) -> MetaOapg.properties.content: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filename"]) -> MetaOapg.properties.filename: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["pageBoundaries"]) -> typing.Union[MetaOapg.properties.pageBoundaries, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["scopes"]) -> typing.Union[MetaOapg.properties.scopes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["content", "filename", "pageBoundaries", "scopes", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + filename: typing.Union[MetaOapg.properties.filename, str, ], + content: typing.Union[MetaOapg.properties.content, str, ], + pageBoundaries: typing.Union[MetaOapg.properties.pageBoundaries, list, tuple, schemas.Unset] = schemas.unset, + scopes: typing.Union[MetaOapg.properties.scopes, list, tuple, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'UpsertKnowledgeDocumentRequestDto': + return super().__new__( + cls, + *_args, + filename=filename, + content=content, + pageBoundaries=pageBoundaries, + scopes=scopes, + title=title, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/upsert_knowledge_document_response_dto.py b/gooddata-api-client/gooddata_api_client/model/upsert_knowledge_document_response_dto.py new file mode 100644 index 000000000..19e0fb39c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/upsert_knowledge_document_response_dto.py @@ -0,0 +1,288 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class UpsertKnowledgeDocumentResponseDto(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'filename': (str,), # noqa: E501 + 'message': (str,), # noqa: E501 + 'num_chunks': (int,), # noqa: E501 + 'success': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'filename': 'filename', # noqa: E501 + 'message': 'message', # noqa: E501 + 'num_chunks': 'numChunks', # noqa: E501 + 'success': 'success', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, filename, message, num_chunks, success, *args, **kwargs): # noqa: E501 + """UpsertKnowledgeDocumentResponseDto - a model defined in OpenAPI + + Args: + filename (str): + message (str): + num_chunks (int): + success (bool): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.filename = filename + self.message = message + self.num_chunks = num_chunks + self.success = success + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, filename, message, num_chunks, success, *args, **kwargs): # noqa: E501 + """UpsertKnowledgeDocumentResponseDto - a model defined in OpenAPI + + Args: + filename (str): + message (str): + num_chunks (int): + success (bool): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.filename = filename + self.message = message + self.num_chunks = num_chunks + self.success = success + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/upsert_knowledge_document_response_dto.pyi b/gooddata-api-client/gooddata_api_client/model/upsert_knowledge_document_response_dto.pyi new file mode 100644 index 000000000..ff91c72dd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/upsert_knowledge_document_response_dto.pyi @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class UpsertKnowledgeDocumentResponseDto( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "numChunks", + "filename", + "success", + "message", + } + + class properties: + filename = schemas.StrSchema + message = schemas.StrSchema + numChunks = schemas.Int32Schema + success = schemas.BoolSchema + __annotations__ = { + "filename": filename, + "message": message, + "numChunks": numChunks, + "success": success, + } + + numChunks: MetaOapg.properties.numChunks + filename: MetaOapg.properties.filename + success: MetaOapg.properties.success + message: MetaOapg.properties.message + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filename"]) -> MetaOapg.properties.filename: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["message"]) -> MetaOapg.properties.message: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["numChunks"]) -> MetaOapg.properties.numChunks: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["success"]) -> MetaOapg.properties.success: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["filename", "message", "numChunks", "success", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filename"]) -> MetaOapg.properties.filename: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["message"]) -> MetaOapg.properties.message: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["numChunks"]) -> MetaOapg.properties.numChunks: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["success"]) -> MetaOapg.properties.success: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["filename", "message", "numChunks", "success", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + numChunks: typing.Union[MetaOapg.properties.numChunks, decimal.Decimal, int, ], + filename: typing.Union[MetaOapg.properties.filename, str, ], + success: typing.Union[MetaOapg.properties.success, bool, ], + message: typing.Union[MetaOapg.properties.message, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'UpsertKnowledgeDocumentResponseDto': + return super().__new__( + cls, + *_args, + numChunks=numChunks, + filename=filename, + success=success, + message=message, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/user_context.pyi b/gooddata-api-client/gooddata_api_client/model/user_context.pyi new file mode 100644 index 000000000..5f2e1167f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/user_context.pyi @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class UserContext( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + User context, which can affect the behavior of the underlying AI features. + """ + + + class MetaOapg: + required = { + "activeObject", + } + + class properties: + + @staticmethod + def activeObject() -> typing.Type['ActiveObjectIdentification']: + return ActiveObjectIdentification + __annotations__ = { + "activeObject": activeObject, + } + + activeObject: 'ActiveObjectIdentification' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["activeObject"]) -> 'ActiveObjectIdentification': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["activeObject", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["activeObject"]) -> 'ActiveObjectIdentification': ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["activeObject", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + activeObject: 'ActiveObjectIdentification', + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'UserContext': + return super().__new__( + cls, + *_args, + activeObject=activeObject, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.active_object_identification import ActiveObjectIdentification diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_data_source_permission_assignment.pyi b/gooddata-api-client/gooddata_api_client/model/user_management_data_source_permission_assignment.pyi new file mode 100644 index 000000000..0f6da6194 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/user_management_data_source_permission_assignment.pyi @@ -0,0 +1,143 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class UserManagementDataSourcePermissionAssignment( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Datasource permission assignments for users and userGroups + """ + + + class MetaOapg: + required = { + "permissions", + "id", + } + + class properties: + id = schemas.StrSchema + + + class permissions( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MANAGE(cls): + return cls("MANAGE") + + @schemas.classproperty + def USE(cls): + return cls("USE") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'permissions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + name = schemas.StrSchema + __annotations__ = { + "id": id, + "permissions": permissions, + "name": name, + } + + permissions: MetaOapg.properties.permissions + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "permissions", "name", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "permissions", "name", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + permissions: typing.Union[MetaOapg.properties.permissions, list, tuple, ], + id: typing.Union[MetaOapg.properties.id, str, ], + name: typing.Union[MetaOapg.properties.name, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'UserManagementDataSourcePermissionAssignment': + return super().__new__( + cls, + *_args, + permissions=permissions, + id=id, + name=name, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_permission_assignments.pyi b/gooddata-api-client/gooddata_api_client/model/user_management_permission_assignments.pyi new file mode 100644 index 000000000..e53c7a2c0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/user_management_permission_assignments.pyi @@ -0,0 +1,149 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class UserManagementPermissionAssignments( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "workspaces", + "dataSources", + } + + class properties: + + + class dataSources( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['UserManagementDataSourcePermissionAssignment']: + return UserManagementDataSourcePermissionAssignment + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['UserManagementDataSourcePermissionAssignment'], typing.List['UserManagementDataSourcePermissionAssignment']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dataSources': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'UserManagementDataSourcePermissionAssignment': + return super().__getitem__(i) + + + class workspaces( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['UserManagementWorkspacePermissionAssignment']: + return UserManagementWorkspacePermissionAssignment + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['UserManagementWorkspacePermissionAssignment'], typing.List['UserManagementWorkspacePermissionAssignment']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'workspaces': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'UserManagementWorkspacePermissionAssignment': + return super().__getitem__(i) + __annotations__ = { + "dataSources": dataSources, + "workspaces": workspaces, + } + + workspaces: MetaOapg.properties.workspaces + dataSources: MetaOapg.properties.dataSources + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataSources"]) -> MetaOapg.properties.dataSources: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workspaces"]) -> MetaOapg.properties.workspaces: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataSources", "workspaces", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataSources"]) -> MetaOapg.properties.dataSources: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workspaces"]) -> MetaOapg.properties.workspaces: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataSources", "workspaces", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + workspaces: typing.Union[MetaOapg.properties.workspaces, list, tuple, ], + dataSources: typing.Union[MetaOapg.properties.dataSources, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'UserManagementPermissionAssignments': + return super().__new__( + cls, + *_args, + workspaces=workspaces, + dataSources=dataSources, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.user_management_data_source_permission_assignment import UserManagementDataSourcePermissionAssignment +from gooddata_api_client.model.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_user_group_member.pyi b/gooddata-api-client/gooddata_api_client/model/user_management_user_group_member.pyi new file mode 100644 index 000000000..4fd066b81 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/user_management_user_group_member.pyi @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class UserManagementUserGroupMember( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "id", + } + + class properties: + id = schemas.StrSchema + name = schemas.StrSchema + __annotations__ = { + "id": id, + "name": name, + } + + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "name", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "name", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + name: typing.Union[MetaOapg.properties.name, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'UserManagementUserGroupMember': + return super().__new__( + cls, + *_args, + id=id, + name=name, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_user_group_members.pyi b/gooddata-api-client/gooddata_api_client/model/user_management_user_group_members.pyi new file mode 100644 index 000000000..70e211655 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/user_management_user_group_members.pyi @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class UserManagementUserGroupMembers( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "members", + } + + class properties: + + + class members( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['UserManagementUserGroupMember']: + return UserManagementUserGroupMember + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['UserManagementUserGroupMember'], typing.List['UserManagementUserGroupMember']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'members': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'UserManagementUserGroupMember': + return super().__getitem__(i) + __annotations__ = { + "members": members, + } + + members: MetaOapg.properties.members + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["members"]) -> MetaOapg.properties.members: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["members", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["members"]) -> MetaOapg.properties.members: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["members", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + members: typing.Union[MetaOapg.properties.members, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'UserManagementUserGroupMembers': + return super().__new__( + cls, + *_args, + members=members, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.user_management_user_group_member import UserManagementUserGroupMember diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_user_groups.pyi b/gooddata-api-client/gooddata_api_client/model/user_management_user_groups.pyi new file mode 100644 index 000000000..2f32127ef --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/user_management_user_groups.pyi @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class UserManagementUserGroups( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "userGroups", + "totalCount", + } + + class properties: + totalCount = schemas.Int32Schema + + + class userGroups( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['UserManagementUserGroupsItem']: + return UserManagementUserGroupsItem + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['UserManagementUserGroupsItem'], typing.List['UserManagementUserGroupsItem']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'userGroups': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'UserManagementUserGroupsItem': + return super().__getitem__(i) + __annotations__ = { + "totalCount": totalCount, + "userGroups": userGroups, + } + + userGroups: MetaOapg.properties.userGroups + totalCount: MetaOapg.properties.totalCount + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["totalCount"]) -> MetaOapg.properties.totalCount: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["totalCount", "userGroups", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["totalCount"]) -> MetaOapg.properties.totalCount: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["totalCount", "userGroups", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + userGroups: typing.Union[MetaOapg.properties.userGroups, list, tuple, ], + totalCount: typing.Union[MetaOapg.properties.totalCount, decimal.Decimal, int, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'UserManagementUserGroups': + return super().__new__( + cls, + *_args, + userGroups=userGroups, + totalCount=totalCount, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.user_management_user_groups_item import UserManagementUserGroupsItem diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_user_groups_item.pyi b/gooddata-api-client/gooddata_api_client/model/user_management_user_groups_item.pyi new file mode 100644 index 000000000..12c9e81d0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/user_management_user_groups_item.pyi @@ -0,0 +1,197 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class UserManagementUserGroupsItem( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + List of groups + """ + + + class MetaOapg: + required = { + "userCount", + "id", + "workspaces", + "dataSources", + "organizationAdmin", + } + + class properties: + + + class dataSources( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['UserManagementDataSourcePermissionAssignment']: + return UserManagementDataSourcePermissionAssignment + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['UserManagementDataSourcePermissionAssignment'], typing.List['UserManagementDataSourcePermissionAssignment']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dataSources': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'UserManagementDataSourcePermissionAssignment': + return super().__getitem__(i) + id = schemas.StrSchema + organizationAdmin = schemas.BoolSchema + userCount = schemas.Int32Schema + + + class workspaces( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['UserManagementWorkspacePermissionAssignment']: + return UserManagementWorkspacePermissionAssignment + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['UserManagementWorkspacePermissionAssignment'], typing.List['UserManagementWorkspacePermissionAssignment']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'workspaces': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'UserManagementWorkspacePermissionAssignment': + return super().__getitem__(i) + name = schemas.StrSchema + __annotations__ = { + "dataSources": dataSources, + "id": id, + "organizationAdmin": organizationAdmin, + "userCount": userCount, + "workspaces": workspaces, + "name": name, + } + + userCount: MetaOapg.properties.userCount + id: MetaOapg.properties.id + workspaces: MetaOapg.properties.workspaces + dataSources: MetaOapg.properties.dataSources + organizationAdmin: MetaOapg.properties.organizationAdmin + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataSources"]) -> MetaOapg.properties.dataSources: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["organizationAdmin"]) -> MetaOapg.properties.organizationAdmin: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["userCount"]) -> MetaOapg.properties.userCount: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workspaces"]) -> MetaOapg.properties.workspaces: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataSources", "id", "organizationAdmin", "userCount", "workspaces", "name", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataSources"]) -> MetaOapg.properties.dataSources: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["organizationAdmin"]) -> MetaOapg.properties.organizationAdmin: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["userCount"]) -> MetaOapg.properties.userCount: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workspaces"]) -> MetaOapg.properties.workspaces: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataSources", "id", "organizationAdmin", "userCount", "workspaces", "name", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + userCount: typing.Union[MetaOapg.properties.userCount, decimal.Decimal, int, ], + id: typing.Union[MetaOapg.properties.id, str, ], + workspaces: typing.Union[MetaOapg.properties.workspaces, list, tuple, ], + dataSources: typing.Union[MetaOapg.properties.dataSources, list, tuple, ], + organizationAdmin: typing.Union[MetaOapg.properties.organizationAdmin, bool, ], + name: typing.Union[MetaOapg.properties.name, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'UserManagementUserGroupsItem': + return super().__new__( + cls, + *_args, + userCount=userCount, + id=id, + workspaces=workspaces, + dataSources=dataSources, + organizationAdmin=organizationAdmin, + name=name, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.user_management_data_source_permission_assignment import UserManagementDataSourcePermissionAssignment +from gooddata_api_client.model.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_users.pyi b/gooddata-api-client/gooddata_api_client/model/user_management_users.pyi new file mode 100644 index 000000000..b4d5425a7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/user_management_users.pyi @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class UserManagementUsers( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "totalCount", + "users", + } + + class properties: + totalCount = schemas.Int32Schema + + + class users( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['UserManagementUsersItem']: + return UserManagementUsersItem + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['UserManagementUsersItem'], typing.List['UserManagementUsersItem']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'users': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'UserManagementUsersItem': + return super().__getitem__(i) + __annotations__ = { + "totalCount": totalCount, + "users": users, + } + + totalCount: MetaOapg.properties.totalCount + users: MetaOapg.properties.users + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["totalCount"]) -> MetaOapg.properties.totalCount: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["totalCount", "users", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["totalCount"]) -> MetaOapg.properties.totalCount: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["totalCount", "users", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + totalCount: typing.Union[MetaOapg.properties.totalCount, decimal.Decimal, int, ], + users: typing.Union[MetaOapg.properties.users, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'UserManagementUsers': + return super().__new__( + cls, + *_args, + totalCount=totalCount, + users=users, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.user_management_users_item import UserManagementUsersItem diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_users_item.pyi b/gooddata-api-client/gooddata_api_client/model/user_management_users_item.pyi new file mode 100644 index 000000000..4abe125b2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/user_management_users_item.pyi @@ -0,0 +1,233 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class UserManagementUsersItem( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + List of users + """ + + + class MetaOapg: + required = { + "userGroups", + "id", + "workspaces", + "dataSources", + "organizationAdmin", + } + + class properties: + + + class dataSources( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['UserManagementDataSourcePermissionAssignment']: + return UserManagementDataSourcePermissionAssignment + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['UserManagementDataSourcePermissionAssignment'], typing.List['UserManagementDataSourcePermissionAssignment']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dataSources': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'UserManagementDataSourcePermissionAssignment': + return super().__getitem__(i) + id = schemas.StrSchema + organizationAdmin = schemas.BoolSchema + + + class userGroups( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['UserGroupIdentifier']: + return UserGroupIdentifier + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['UserGroupIdentifier'], typing.List['UserGroupIdentifier']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'userGroups': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'UserGroupIdentifier': + return super().__getitem__(i) + + + class workspaces( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['UserManagementWorkspacePermissionAssignment']: + return UserManagementWorkspacePermissionAssignment + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['UserManagementWorkspacePermissionAssignment'], typing.List['UserManagementWorkspacePermissionAssignment']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'workspaces': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'UserManagementWorkspacePermissionAssignment': + return super().__getitem__(i) + email = schemas.StrSchema + name = schemas.StrSchema + __annotations__ = { + "dataSources": dataSources, + "id": id, + "organizationAdmin": organizationAdmin, + "userGroups": userGroups, + "workspaces": workspaces, + "email": email, + "name": name, + } + + userGroups: MetaOapg.properties.userGroups + id: MetaOapg.properties.id + workspaces: MetaOapg.properties.workspaces + dataSources: MetaOapg.properties.dataSources + organizationAdmin: MetaOapg.properties.organizationAdmin + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dataSources"]) -> MetaOapg.properties.dataSources: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["organizationAdmin"]) -> MetaOapg.properties.organizationAdmin: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["workspaces"]) -> MetaOapg.properties.workspaces: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dataSources", "id", "organizationAdmin", "userGroups", "workspaces", "email", "name", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dataSources"]) -> MetaOapg.properties.dataSources: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["organizationAdmin"]) -> MetaOapg.properties.organizationAdmin: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["workspaces"]) -> MetaOapg.properties.workspaces: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["email"]) -> typing.Union[MetaOapg.properties.email, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dataSources", "id", "organizationAdmin", "userGroups", "workspaces", "email", "name", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + userGroups: typing.Union[MetaOapg.properties.userGroups, list, tuple, ], + id: typing.Union[MetaOapg.properties.id, str, ], + workspaces: typing.Union[MetaOapg.properties.workspaces, list, tuple, ], + dataSources: typing.Union[MetaOapg.properties.dataSources, list, tuple, ], + organizationAdmin: typing.Union[MetaOapg.properties.organizationAdmin, bool, ], + email: typing.Union[MetaOapg.properties.email, str, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'UserManagementUsersItem': + return super().__new__( + cls, + *_args, + userGroups=userGroups, + id=id, + workspaces=workspaces, + dataSources=dataSources, + organizationAdmin=organizationAdmin, + email=email, + name=name, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.user_group_identifier import UserGroupIdentifier +from gooddata_api_client.model.user_management_data_source_permission_assignment import UserManagementDataSourcePermissionAssignment +from gooddata_api_client.model.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment 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 3f48d6fa5..ca54223c6 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 @@ -64,6 +64,8 @@ class UserManagementWorkspacePermissionAssignment(ModelNormal): 'EXPORT_PDF': "EXPORT_PDF", 'CREATE_AUTOMATION': "CREATE_AUTOMATION", 'USE_AI_ASSISTANT': "USE_AI_ASSISTANT", + 'WRITE_KNOWLEDGE_DOCUMENTS': "WRITE_KNOWLEDGE_DOCUMENTS", + 'READ_KNOWLEDGE_DOCUMENTS': "READ_KNOWLEDGE_DOCUMENTS", 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", 'VIEW': "VIEW", }, @@ -75,6 +77,8 @@ class UserManagementWorkspacePermissionAssignment(ModelNormal): 'EXPORT_PDF': "EXPORT_PDF", 'CREATE_AUTOMATION': "CREATE_AUTOMATION", 'USE_AI_ASSISTANT': "USE_AI_ASSISTANT", + 'WRITE_KNOWLEDGE_DOCUMENTS': "WRITE_KNOWLEDGE_DOCUMENTS", + 'READ_KNOWLEDGE_DOCUMENTS': "READ_KNOWLEDGE_DOCUMENTS", 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", 'VIEW': "VIEW", }, diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_workspace_permission_assignment.pyi b/gooddata-api-client/gooddata_api_client/model/user_management_workspace_permission_assignment.pyi new file mode 100644 index 000000000..887e7e3c5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/user_management_workspace_permission_assignment.pyi @@ -0,0 +1,262 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class UserManagementWorkspacePermissionAssignment( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Workspace permission assignments for users and userGroups + """ + + + class MetaOapg: + required = { + "permissions", + "id", + "hierarchyPermissions", + } + + class properties: + + + class hierarchyPermissions( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MANAGE(cls): + return cls("MANAGE") + + @schemas.classproperty + def ANALYZE(cls): + return cls("ANALYZE") + + @schemas.classproperty + def EXPORT(cls): + return cls("EXPORT") + + @schemas.classproperty + def EXPORT_TABULAR(cls): + return cls("EXPORT_TABULAR") + + @schemas.classproperty + def EXPORT_PDF(cls): + return cls("EXPORT_PDF") + + @schemas.classproperty + def CREATE_AUTOMATION(cls): + return cls("CREATE_AUTOMATION") + + @schemas.classproperty + def USE_AI_ASSISTANT(cls): + return cls("USE_AI_ASSISTANT") + + @schemas.classproperty + def WRITE_KNOWLEDGE_DOCUMENTS(cls): + return cls("WRITE_KNOWLEDGE_DOCUMENTS") + + @schemas.classproperty + def READ_KNOWLEDGE_DOCUMENTS(cls): + return cls("READ_KNOWLEDGE_DOCUMENTS") + + @schemas.classproperty + def CREATE_FILTER_VIEW(cls): + return cls("CREATE_FILTER_VIEW") + + @schemas.classproperty + def VIEW(cls): + return cls("VIEW") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'hierarchyPermissions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + id = schemas.StrSchema + + + class permissions( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MANAGE(cls): + return cls("MANAGE") + + @schemas.classproperty + def ANALYZE(cls): + return cls("ANALYZE") + + @schemas.classproperty + def EXPORT(cls): + return cls("EXPORT") + + @schemas.classproperty + def EXPORT_TABULAR(cls): + return cls("EXPORT_TABULAR") + + @schemas.classproperty + def EXPORT_PDF(cls): + return cls("EXPORT_PDF") + + @schemas.classproperty + def CREATE_AUTOMATION(cls): + return cls("CREATE_AUTOMATION") + + @schemas.classproperty + def USE_AI_ASSISTANT(cls): + return cls("USE_AI_ASSISTANT") + + @schemas.classproperty + def WRITE_KNOWLEDGE_DOCUMENTS(cls): + return cls("WRITE_KNOWLEDGE_DOCUMENTS") + + @schemas.classproperty + def READ_KNOWLEDGE_DOCUMENTS(cls): + return cls("READ_KNOWLEDGE_DOCUMENTS") + + @schemas.classproperty + def CREATE_FILTER_VIEW(cls): + return cls("CREATE_FILTER_VIEW") + + @schemas.classproperty + def VIEW(cls): + return cls("VIEW") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'permissions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + name = schemas.StrSchema + __annotations__ = { + "hierarchyPermissions": hierarchyPermissions, + "id": id, + "permissions": permissions, + "name": name, + } + + permissions: MetaOapg.properties.permissions + id: MetaOapg.properties.id + hierarchyPermissions: MetaOapg.properties.hierarchyPermissions + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["hierarchyPermissions"]) -> MetaOapg.properties.hierarchyPermissions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["hierarchyPermissions", "id", "permissions", "name", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["hierarchyPermissions"]) -> MetaOapg.properties.hierarchyPermissions: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["hierarchyPermissions", "id", "permissions", "name", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + permissions: typing.Union[MetaOapg.properties.permissions, list, tuple, ], + id: typing.Union[MetaOapg.properties.id, str, ], + hierarchyPermissions: typing.Union[MetaOapg.properties.hierarchyPermissions, list, tuple, ], + name: typing.Union[MetaOapg.properties.name, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'UserManagementWorkspacePermissionAssignment': + return super().__new__( + cls, + *_args, + permissions=permissions, + id=id, + hierarchyPermissions=hierarchyPermissions, + name=name, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/validate_by_item.pyi b/gooddata-api-client/gooddata_api_client/model/validate_by_item.pyi new file mode 100644 index 000000000..dbda74bc2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/validate_by_item.pyi @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ValidateByItem( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "id", + "type", + } + + class properties: + id = schemas.StrSchema + + + class type( + schemas.StrSchema + ): + pass + __annotations__ = { + "id": id, + "type": type, + } + + + id: MetaOapg.properties.id + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ValidateByItem': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_by_id_request.pyi b/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_by_id_request.pyi new file mode 100644 index 000000000..63f05189f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_by_id_request.pyi @@ -0,0 +1,119 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ValidateLLMEndpointByIdRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + baseUrl = schemas.StrSchema + llmModel = schemas.StrSchema + llmOrganization = schemas.StrSchema + provider = schemas.StrSchema + token = schemas.StrSchema + __annotations__ = { + "baseUrl": baseUrl, + "llmModel": llmModel, + "llmOrganization": llmOrganization, + "provider": provider, + "token": token, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["baseUrl"]) -> MetaOapg.properties.baseUrl: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["llmModel"]) -> MetaOapg.properties.llmModel: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["llmOrganization"]) -> MetaOapg.properties.llmOrganization: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["provider"]) -> MetaOapg.properties.provider: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["token"]) -> MetaOapg.properties.token: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["baseUrl", "llmModel", "llmOrganization", "provider", "token", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["baseUrl"]) -> typing.Union[MetaOapg.properties.baseUrl, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["llmModel"]) -> typing.Union[MetaOapg.properties.llmModel, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["llmOrganization"]) -> typing.Union[MetaOapg.properties.llmOrganization, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["provider"]) -> typing.Union[MetaOapg.properties.provider, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["token"]) -> typing.Union[MetaOapg.properties.token, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["baseUrl", "llmModel", "llmOrganization", "provider", "token", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + baseUrl: typing.Union[MetaOapg.properties.baseUrl, str, schemas.Unset] = schemas.unset, + llmModel: typing.Union[MetaOapg.properties.llmModel, str, schemas.Unset] = schemas.unset, + llmOrganization: typing.Union[MetaOapg.properties.llmOrganization, str, schemas.Unset] = schemas.unset, + provider: typing.Union[MetaOapg.properties.provider, str, schemas.Unset] = schemas.unset, + token: typing.Union[MetaOapg.properties.token, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ValidateLLMEndpointByIdRequest': + return super().__new__( + cls, + *_args, + baseUrl=baseUrl, + llmModel=llmModel, + llmOrganization=llmOrganization, + provider=provider, + token=token, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_request.pyi b/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_request.pyi new file mode 100644 index 000000000..f82dfe0df --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_request.pyi @@ -0,0 +1,126 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ValidateLLMEndpointRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "provider", + "token", + } + + class properties: + provider = schemas.StrSchema + token = schemas.StrSchema + baseUrl = schemas.StrSchema + llmModel = schemas.StrSchema + llmOrganization = schemas.StrSchema + __annotations__ = { + "provider": provider, + "token": token, + "baseUrl": baseUrl, + "llmModel": llmModel, + "llmOrganization": llmOrganization, + } + + provider: MetaOapg.properties.provider + token: MetaOapg.properties.token + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["provider"]) -> MetaOapg.properties.provider: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["token"]) -> MetaOapg.properties.token: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["baseUrl"]) -> MetaOapg.properties.baseUrl: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["llmModel"]) -> MetaOapg.properties.llmModel: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["llmOrganization"]) -> MetaOapg.properties.llmOrganization: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["provider", "token", "baseUrl", "llmModel", "llmOrganization", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["provider"]) -> MetaOapg.properties.provider: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["token"]) -> MetaOapg.properties.token: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["baseUrl"]) -> typing.Union[MetaOapg.properties.baseUrl, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["llmModel"]) -> typing.Union[MetaOapg.properties.llmModel, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["llmOrganization"]) -> typing.Union[MetaOapg.properties.llmOrganization, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["provider", "token", "baseUrl", "llmModel", "llmOrganization", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + provider: typing.Union[MetaOapg.properties.provider, str, ], + token: typing.Union[MetaOapg.properties.token, str, ], + baseUrl: typing.Union[MetaOapg.properties.baseUrl, str, schemas.Unset] = schemas.unset, + llmModel: typing.Union[MetaOapg.properties.llmModel, str, schemas.Unset] = schemas.unset, + llmOrganization: typing.Union[MetaOapg.properties.llmOrganization, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ValidateLLMEndpointRequest': + return super().__new__( + cls, + *_args, + provider=provider, + token=token, + baseUrl=baseUrl, + llmModel=llmModel, + llmOrganization=llmOrganization, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_response.pyi b/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_response.pyi new file mode 100644 index 000000000..590b0deaa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/validate_llm_endpoint_response.pyi @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class ValidateLLMEndpointResponse( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "message", + "successful", + } + + class properties: + message = schemas.StrSchema + successful = schemas.BoolSchema + __annotations__ = { + "message": message, + "successful": successful, + } + + message: MetaOapg.properties.message + successful: MetaOapg.properties.successful + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["message"]) -> MetaOapg.properties.message: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["successful"]) -> MetaOapg.properties.successful: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["message", "successful", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["message"]) -> MetaOapg.properties.message: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["successful"]) -> MetaOapg.properties.successful: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["message", "successful", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + message: typing.Union[MetaOapg.properties.message, str, ], + successful: typing.Union[MetaOapg.properties.successful, bool, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'ValidateLLMEndpointResponse': + return super().__new__( + cls, + *_args, + message=message, + successful=successful, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/value.pyi b/gooddata-api-client/gooddata_api_client/model/value.pyi new file mode 100644 index 000000000..ce69a4995 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/value.pyi @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Value( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "value", + } + + class properties: + value = schemas.NumberSchema + __annotations__ = { + "value": value, + } + + value: MetaOapg.properties.value + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["value", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["value"]) -> MetaOapg.properties.value: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["value", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + value: typing.Union[MetaOapg.properties.value, decimal.Decimal, int, float, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Value': + return super().__new__( + cls, + *_args, + value=value, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/visible_filter.pyi b/gooddata-api-client/gooddata_api_client/model/visible_filter.pyi new file mode 100644 index 000000000..c5eb1f6e1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/visible_filter.pyi @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class VisibleFilter( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + isAllTimeDateFilter = schemas.BoolSchema + localIdentifier = schemas.StrSchema + title = schemas.StrSchema + __annotations__ = { + "isAllTimeDateFilter": isAllTimeDateFilter, + "localIdentifier": localIdentifier, + "title": title, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isAllTimeDateFilter"]) -> MetaOapg.properties.isAllTimeDateFilter: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["localIdentifier"]) -> MetaOapg.properties.localIdentifier: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["isAllTimeDateFilter", "localIdentifier", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isAllTimeDateFilter"]) -> typing.Union[MetaOapg.properties.isAllTimeDateFilter, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["localIdentifier"]) -> typing.Union[MetaOapg.properties.localIdentifier, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["isAllTimeDateFilter", "localIdentifier", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + isAllTimeDateFilter: typing.Union[MetaOapg.properties.isAllTimeDateFilter, bool, schemas.Unset] = schemas.unset, + localIdentifier: typing.Union[MetaOapg.properties.localIdentifier, str, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'VisibleFilter': + return super().__new__( + cls, + *_args, + isAllTimeDateFilter=isAllTimeDateFilter, + localIdentifier=localIdentifier, + title=title, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/visual_export_request.pyi b/gooddata-api-client/gooddata_api_client/model/visual_export_request.pyi new file mode 100644 index 000000000..03d51e373 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/visual_export_request.pyi @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class VisualExportRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Export request object describing the export properties and metadata for dashboard PDF exports. + """ + + + class MetaOapg: + required = { + "fileName", + "dashboardId", + } + + class properties: + dashboardId = schemas.StrSchema + fileName = schemas.StrSchema + metadata = schemas.DictSchema + __annotations__ = { + "dashboardId": dashboardId, + "fileName": fileName, + "metadata": metadata, + } + + fileName: MetaOapg.properties.fileName + dashboardId: MetaOapg.properties.dashboardId + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardId"]) -> MetaOapg.properties.dashboardId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metadata"]) -> MetaOapg.properties.metadata: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dashboardId", "fileName", "metadata", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardId"]) -> MetaOapg.properties.dashboardId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["fileName"]) -> MetaOapg.properties.fileName: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metadata"]) -> typing.Union[MetaOapg.properties.metadata, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dashboardId", "fileName", "metadata", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + fileName: typing.Union[MetaOapg.properties.fileName, str, ], + dashboardId: typing.Union[MetaOapg.properties.dashboardId, str, ], + metadata: typing.Union[MetaOapg.properties.metadata, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'VisualExportRequest': + return super().__new__( + cls, + *_args, + fileName=fileName, + dashboardId=dashboardId, + metadata=metadata, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/visualization_config.py b/gooddata-api-client/gooddata_api_client/model/visualization_config.py new file mode 100644 index 000000000..56afa4fe1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/visualization_config.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.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_config.pyi b/gooddata-api-client/gooddata_api_client/model/visualization_config.pyi new file mode 100644 index 000000000..bd988fd0e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/visualization_config.pyi @@ -0,0 +1,128 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class VisualizationConfig( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Visualization config for smart-function rendering. + """ + + + class MetaOapg: + + class properties: + + @staticmethod + def anomalyDetection() -> typing.Type['AnomalyDetectionConfig']: + return AnomalyDetectionConfig + + @staticmethod + def clustering() -> typing.Type['ClusteringConfig']: + return ClusteringConfig + + @staticmethod + def forecast() -> typing.Type['ForecastConfig']: + return ForecastConfig + + @staticmethod + def whatIf() -> typing.Type['WhatIfScenarioConfig']: + return WhatIfScenarioConfig + __annotations__ = { + "anomalyDetection": anomalyDetection, + "clustering": clustering, + "forecast": forecast, + "whatIf": whatIf, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["anomalyDetection"]) -> 'AnomalyDetectionConfig': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["clustering"]) -> 'ClusteringConfig': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["forecast"]) -> 'ForecastConfig': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["whatIf"]) -> 'WhatIfScenarioConfig': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["anomalyDetection", "clustering", "forecast", "whatIf", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["anomalyDetection"]) -> typing.Union['AnomalyDetectionConfig', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["clustering"]) -> typing.Union['ClusteringConfig', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["forecast"]) -> typing.Union['ForecastConfig', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["whatIf"]) -> typing.Union['WhatIfScenarioConfig', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["anomalyDetection", "clustering", "forecast", "whatIf", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + anomalyDetection: typing.Union['AnomalyDetectionConfig', schemas.Unset] = schemas.unset, + clustering: typing.Union['ClusteringConfig', schemas.Unset] = schemas.unset, + forecast: typing.Union['ForecastConfig', schemas.Unset] = schemas.unset, + whatIf: typing.Union['WhatIfScenarioConfig', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'VisualizationConfig': + return super().__new__( + cls, + *_args, + anomalyDetection=anomalyDetection, + clustering=clustering, + forecast=forecast, + whatIf=whatIf, + _configuration=_configuration, + **kwargs, + ) + +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 diff --git a/gooddata-api-client/gooddata_api_client/model/webhook.py b/gooddata-api-client/gooddata_api_client/model/webhook.py index f0471f2ff..50ba1edf1 100644 --- a/gooddata-api-client/gooddata_api_client/model/webhook.py +++ b/gooddata-api-client/gooddata_api_client/model/webhook.py @@ -66,6 +66,10 @@ class Webhook(ModelComposed): } validations = { + ('has_secret_key',): { + }, + ('has_token',): { + }, ('secret_key',): { 'max_length': 10000, }, diff --git a/gooddata-api-client/gooddata_api_client/model/webhook.pyi b/gooddata-api-client/gooddata_api_client/model/webhook.pyi new file mode 100644 index 000000000..999086dc7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/webhook.pyi @@ -0,0 +1,456 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Webhook( + schemas.ComposedBase, + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Webhook destination for notifications. The property url is required on create and update. + """ + + + class MetaOapg: + required = { + "type", + } + + class properties: + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def WEBHOOK(cls): + return cls("WEBHOOK") + + + class hasSecretKey( + schemas.BoolBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneBoolMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, bool, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'hasSecretKey': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class hasToken( + schemas.BoolBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneBoolMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, bool, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'hasToken': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class secretKey( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'secretKey': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class token( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'token': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class url( + schemas.StrSchema + ): + pass + __annotations__ = { + "type": type, + "hasSecretKey": hasSecretKey, + "hasToken": hasToken, + "secretKey": secretKey, + "token": token, + "url": url, + } + + + class all_of_0( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + + + class hasSecretKey( + schemas.BoolBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneBoolMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, bool, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'hasSecretKey': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class hasToken( + schemas.BoolBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneBoolMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, bool, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'hasToken': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class secretKey( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'secretKey': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class token( + schemas.StrBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneStrMixin + ): + + + class MetaOapg: + + + def __new__( + cls, + *_args: typing.Union[None, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'token': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + ) + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def WEBHOOK(cls): + return cls("WEBHOOK") + + + class url( + schemas.StrSchema + ): + pass + __annotations__ = { + "hasSecretKey": hasSecretKey, + "hasToken": hasToken, + "secretKey": secretKey, + "token": token, + "type": type, + "url": url, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["hasSecretKey"]) -> MetaOapg.properties.hasSecretKey: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["hasToken"]) -> MetaOapg.properties.hasToken: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["secretKey"]) -> MetaOapg.properties.secretKey: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["token"]) -> MetaOapg.properties.token: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["url"]) -> MetaOapg.properties.url: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["hasSecretKey", "hasToken", "secretKey", "token", "type", "url", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["hasSecretKey"]) -> typing.Union[MetaOapg.properties.hasSecretKey, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["hasToken"]) -> typing.Union[MetaOapg.properties.hasToken, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["secretKey"]) -> typing.Union[MetaOapg.properties.secretKey, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["token"]) -> typing.Union[MetaOapg.properties.token, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> typing.Union[MetaOapg.properties.type, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["url"]) -> typing.Union[MetaOapg.properties.url, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["hasSecretKey", "hasToken", "secretKey", "token", "type", "url", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + hasSecretKey: typing.Union[MetaOapg.properties.hasSecretKey, None, bool, schemas.Unset] = schemas.unset, + hasToken: typing.Union[MetaOapg.properties.hasToken, None, bool, schemas.Unset] = schemas.unset, + secretKey: typing.Union[MetaOapg.properties.secretKey, None, str, schemas.Unset] = schemas.unset, + token: typing.Union[MetaOapg.properties.token, None, str, schemas.Unset] = schemas.unset, + type: typing.Union[MetaOapg.properties.type, str, schemas.Unset] = schemas.unset, + url: typing.Union[MetaOapg.properties.url, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'all_of_0': + return super().__new__( + cls, + *_args, + hasSecretKey=hasSecretKey, + hasToken=hasToken, + secretKey=secretKey, + token=token, + type=type, + url=url, + _configuration=_configuration, + **kwargs, + ) + + @classmethod + @functools.lru_cache() + def all_of(cls): + # 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 + return [ + cls.all_of_0, + ] + + + type: MetaOapg.properties.type + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["hasSecretKey"]) -> MetaOapg.properties.hasSecretKey: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["hasToken"]) -> MetaOapg.properties.hasToken: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["secretKey"]) -> MetaOapg.properties.secretKey: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["token"]) -> MetaOapg.properties.token: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["url"]) -> MetaOapg.properties.url: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["type", "hasSecretKey", "hasToken", "secretKey", "token", "url", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["hasSecretKey"]) -> typing.Union[MetaOapg.properties.hasSecretKey, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["hasToken"]) -> typing.Union[MetaOapg.properties.hasToken, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["secretKey"]) -> typing.Union[MetaOapg.properties.secretKey, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["token"]) -> typing.Union[MetaOapg.properties.token, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["url"]) -> typing.Union[MetaOapg.properties.url, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["type", "hasSecretKey", "hasToken", "secretKey", "token", "url", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + type: typing.Union[MetaOapg.properties.type, str, ], + hasSecretKey: typing.Union[MetaOapg.properties.hasSecretKey, None, bool, schemas.Unset] = schemas.unset, + hasToken: typing.Union[MetaOapg.properties.hasToken, None, bool, schemas.Unset] = schemas.unset, + secretKey: typing.Union[MetaOapg.properties.secretKey, None, str, schemas.Unset] = schemas.unset, + token: typing.Union[MetaOapg.properties.token, None, str, schemas.Unset] = schemas.unset, + url: typing.Union[MetaOapg.properties.url, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Webhook': + return super().__new__( + cls, + *_args, + type=type, + hasSecretKey=hasSecretKey, + hasToken=hasToken, + secretKey=secretKey, + token=token, + url=url, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/webhook_all_of.py b/gooddata-api-client/gooddata_api_client/model/webhook_all_of.py index a2e0b1ab7..20a568dcd 100644 --- a/gooddata-api-client/gooddata_api_client/model/webhook_all_of.py +++ b/gooddata-api-client/gooddata_api_client/model/webhook_all_of.py @@ -62,6 +62,10 @@ class WebhookAllOf(ModelNormal): } validations = { + ('has_secret_key',): { + }, + ('has_token',): { + }, ('secret_key',): { 'max_length': 10000, }, diff --git a/gooddata-api-client/gooddata_api_client/model/webhook_automation_info.pyi b/gooddata-api-client/gooddata_api_client/model/webhook_automation_info.pyi new file mode 100644 index 000000000..ed4230ac5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/webhook_automation_info.pyi @@ -0,0 +1,128 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class WebhookAutomationInfo( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "isCustomDashboardURL", + "dashboardURL", + "id", + } + + class properties: + dashboardURL = schemas.StrSchema + id = schemas.StrSchema + isCustomDashboardURL = schemas.BoolSchema + dashboardTitle = schemas.StrSchema + title = schemas.StrSchema + __annotations__ = { + "dashboardURL": dashboardURL, + "id": id, + "isCustomDashboardURL": isCustomDashboardURL, + "dashboardTitle": dashboardTitle, + "title": title, + } + + isCustomDashboardURL: MetaOapg.properties.isCustomDashboardURL + dashboardURL: MetaOapg.properties.dashboardURL + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardURL"]) -> MetaOapg.properties.dashboardURL: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["isCustomDashboardURL"]) -> MetaOapg.properties.isCustomDashboardURL: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardTitle"]) -> MetaOapg.properties.dashboardTitle: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["title"]) -> MetaOapg.properties.title: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["dashboardURL", "id", "isCustomDashboardURL", "dashboardTitle", "title", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardURL"]) -> MetaOapg.properties.dashboardURL: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["isCustomDashboardURL"]) -> MetaOapg.properties.isCustomDashboardURL: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardTitle"]) -> typing.Union[MetaOapg.properties.dashboardTitle, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["title"]) -> typing.Union[MetaOapg.properties.title, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["dashboardURL", "id", "isCustomDashboardURL", "dashboardTitle", "title", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + isCustomDashboardURL: typing.Union[MetaOapg.properties.isCustomDashboardURL, bool, ], + dashboardURL: typing.Union[MetaOapg.properties.dashboardURL, str, ], + id: typing.Union[MetaOapg.properties.id, str, ], + dashboardTitle: typing.Union[MetaOapg.properties.dashboardTitle, str, schemas.Unset] = schemas.unset, + title: typing.Union[MetaOapg.properties.title, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'WebhookAutomationInfo': + return super().__new__( + cls, + *_args, + isCustomDashboardURL=isCustomDashboardURL, + dashboardURL=dashboardURL, + id=id, + dashboardTitle=dashboardTitle, + title=title, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/webhook_message.pyi b/gooddata-api-client/gooddata_api_client/model/webhook_message.pyi new file mode 100644 index 000000000..b2055ecb3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/webhook_message.pyi @@ -0,0 +1,126 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class WebhookMessage( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "data", + "type", + "timestamp", + } + + class properties: + + @staticmethod + def data() -> typing.Type['WebhookMessageData']: + return WebhookMessageData + timestamp = schemas.DateTimeSchema + + + class type( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def COMPLETED(cls): + return cls("automation-task.completed") + + @schemas.classproperty + def LIMITEXCEEDED(cls): + return cls("automation-task.limit-exceeded") + __annotations__ = { + "data": data, + "timestamp": timestamp, + "type": type, + } + + data: 'WebhookMessageData' + type: MetaOapg.properties.type + timestamp: MetaOapg.properties.timestamp + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["data"]) -> 'WebhookMessageData': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["timestamp"]) -> MetaOapg.properties.timestamp: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "timestamp", "type", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> 'WebhookMessageData': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["timestamp"]) -> MetaOapg.properties.timestamp: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["type"]) -> MetaOapg.properties.type: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "timestamp", "type", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + data: 'WebhookMessageData', + type: typing.Union[MetaOapg.properties.type, str, ], + timestamp: typing.Union[MetaOapg.properties.timestamp, str, datetime, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'WebhookMessage': + return super().__new__( + cls, + *_args, + data=data, + type=type, + timestamp=timestamp, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.webhook_message_data import WebhookMessageData diff --git a/gooddata-api-client/gooddata_api_client/model/webhook_message_data.pyi b/gooddata-api-client/gooddata_api_client/model/webhook_message_data.pyi new file mode 100644 index 000000000..567127332 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/webhook_message_data.pyi @@ -0,0 +1,444 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class WebhookMessageData( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "automation", + } + + class properties: + + @staticmethod + def automation() -> typing.Type['WebhookAutomationInfo']: + return WebhookAutomationInfo + + @staticmethod + def alert() -> typing.Type['AlertDescription']: + return AlertDescription + + + class dashboardTabularExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ExportResult']: + return ExportResult + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['ExportResult'], typing.List['ExportResult']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'dashboardTabularExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ExportResult': + return super().__getitem__(i) + + + class details( + schemas.DictSchema + ): + + + class MetaOapg: + additional_properties = schemas.StrSchema + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, str, ], + ) -> 'details': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + + class filters( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['NotificationFilter']: + return NotificationFilter + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['NotificationFilter'], typing.List['NotificationFilter']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'filters': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'NotificationFilter': + return super().__getitem__(i) + + + class imageExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ExportResult']: + return ExportResult + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['ExportResult'], typing.List['ExportResult']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'imageExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ExportResult': + return super().__getitem__(i) + notificationSource = schemas.StrSchema + + + class rawExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ExportResult']: + return ExportResult + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['ExportResult'], typing.List['ExportResult']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'rawExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ExportResult': + return super().__getitem__(i) + + + class recipients( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['WebhookRecipient']: + return WebhookRecipient + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['WebhookRecipient'], typing.List['WebhookRecipient']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'recipients': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'WebhookRecipient': + return super().__getitem__(i) + remainingActionCount = schemas.Int32Schema + + + class slidesExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ExportResult']: + return ExportResult + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['ExportResult'], typing.List['ExportResult']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'slidesExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ExportResult': + return super().__getitem__(i) + + + class tabularExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ExportResult']: + return ExportResult + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['ExportResult'], typing.List['ExportResult']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'tabularExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ExportResult': + return super().__getitem__(i) + + + class visualExports( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ExportResult']: + return ExportResult + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['ExportResult'], typing.List['ExportResult']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'visualExports': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ExportResult': + return super().__getitem__(i) + __annotations__ = { + "automation": automation, + "alert": alert, + "dashboardTabularExports": dashboardTabularExports, + "details": details, + "filters": filters, + "imageExports": imageExports, + "notificationSource": notificationSource, + "rawExports": rawExports, + "recipients": recipients, + "remainingActionCount": remainingActionCount, + "slidesExports": slidesExports, + "tabularExports": tabularExports, + "visualExports": visualExports, + } + + automation: 'WebhookAutomationInfo' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["automation"]) -> 'WebhookAutomationInfo': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["alert"]) -> 'AlertDescription': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["dashboardTabularExports"]) -> MetaOapg.properties.dashboardTabularExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["details"]) -> MetaOapg.properties.details: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["filters"]) -> MetaOapg.properties.filters: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["imageExports"]) -> MetaOapg.properties.imageExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["notificationSource"]) -> MetaOapg.properties.notificationSource: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["rawExports"]) -> MetaOapg.properties.rawExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["recipients"]) -> MetaOapg.properties.recipients: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["remainingActionCount"]) -> MetaOapg.properties.remainingActionCount: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["slidesExports"]) -> MetaOapg.properties.slidesExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["tabularExports"]) -> MetaOapg.properties.tabularExports: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["visualExports"]) -> MetaOapg.properties.visualExports: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["automation", "alert", "dashboardTabularExports", "details", "filters", "imageExports", "notificationSource", "rawExports", "recipients", "remainingActionCount", "slidesExports", "tabularExports", "visualExports", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["automation"]) -> 'WebhookAutomationInfo': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["alert"]) -> typing.Union['AlertDescription', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["dashboardTabularExports"]) -> typing.Union[MetaOapg.properties.dashboardTabularExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["details"]) -> typing.Union[MetaOapg.properties.details, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["filters"]) -> typing.Union[MetaOapg.properties.filters, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["imageExports"]) -> typing.Union[MetaOapg.properties.imageExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["notificationSource"]) -> typing.Union[MetaOapg.properties.notificationSource, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["rawExports"]) -> typing.Union[MetaOapg.properties.rawExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["recipients"]) -> typing.Union[MetaOapg.properties.recipients, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["remainingActionCount"]) -> typing.Union[MetaOapg.properties.remainingActionCount, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["slidesExports"]) -> typing.Union[MetaOapg.properties.slidesExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["tabularExports"]) -> typing.Union[MetaOapg.properties.tabularExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["visualExports"]) -> typing.Union[MetaOapg.properties.visualExports, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["automation", "alert", "dashboardTabularExports", "details", "filters", "imageExports", "notificationSource", "rawExports", "recipients", "remainingActionCount", "slidesExports", "tabularExports", "visualExports", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + automation: 'WebhookAutomationInfo', + alert: typing.Union['AlertDescription', schemas.Unset] = schemas.unset, + dashboardTabularExports: typing.Union[MetaOapg.properties.dashboardTabularExports, list, tuple, schemas.Unset] = schemas.unset, + details: typing.Union[MetaOapg.properties.details, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + filters: typing.Union[MetaOapg.properties.filters, list, tuple, schemas.Unset] = schemas.unset, + imageExports: typing.Union[MetaOapg.properties.imageExports, list, tuple, schemas.Unset] = schemas.unset, + notificationSource: typing.Union[MetaOapg.properties.notificationSource, str, schemas.Unset] = schemas.unset, + rawExports: typing.Union[MetaOapg.properties.rawExports, list, tuple, schemas.Unset] = schemas.unset, + recipients: typing.Union[MetaOapg.properties.recipients, list, tuple, schemas.Unset] = schemas.unset, + remainingActionCount: typing.Union[MetaOapg.properties.remainingActionCount, decimal.Decimal, int, schemas.Unset] = schemas.unset, + slidesExports: typing.Union[MetaOapg.properties.slidesExports, list, tuple, schemas.Unset] = schemas.unset, + tabularExports: typing.Union[MetaOapg.properties.tabularExports, list, tuple, schemas.Unset] = schemas.unset, + visualExports: typing.Union[MetaOapg.properties.visualExports, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'WebhookMessageData': + return super().__new__( + cls, + *_args, + automation=automation, + alert=alert, + dashboardTabularExports=dashboardTabularExports, + details=details, + filters=filters, + imageExports=imageExports, + notificationSource=notificationSource, + rawExports=rawExports, + recipients=recipients, + remainingActionCount=remainingActionCount, + slidesExports=slidesExports, + tabularExports=tabularExports, + visualExports=visualExports, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.alert_description import AlertDescription +from gooddata_api_client.model.export_result import ExportResult +from gooddata_api_client.model.notification_filter import NotificationFilter +from gooddata_api_client.model.webhook_automation_info import WebhookAutomationInfo +from gooddata_api_client.model.webhook_recipient import WebhookRecipient diff --git a/gooddata-api-client/gooddata_api_client/model/webhook_recipient.pyi b/gooddata-api-client/gooddata_api_client/model/webhook_recipient.pyi new file mode 100644 index 000000000..703344c69 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/webhook_recipient.pyi @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class WebhookRecipient( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "id", + "email", + } + + class properties: + email = schemas.StrSchema + id = schemas.StrSchema + __annotations__ = { + "email": email, + "id": id, + } + + id: MetaOapg.properties.id + email: MetaOapg.properties.email + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["email", "id", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["email", "id", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + email: typing.Union[MetaOapg.properties.email, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'WebhookRecipient': + return super().__new__( + cls, + *_args, + id=id, + email=email, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/what_if_measure_adjustment_config.py b/gooddata-api-client/gooddata_api_client/model/what_if_measure_adjustment_config.py new file mode 100644 index 000000000..71ab7791e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/what_if_measure_adjustment_config.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 WhatIfMeasureAdjustmentConfig(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_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 { + 'metric_id': (str,), # noqa: E501 + 'metric_type': (str,), # noqa: E501 + 'scenario_maql': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'metric_id': 'metricId', # noqa: E501 + 'metric_type': 'metricType', # noqa: E501 + 'scenario_maql': 'scenarioMaql', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @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 + + 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 + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.metric_id = metric_id + self.metric_type = metric_type + self.scenario_maql = scenario_maql + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @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 + + 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 + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.metric_id = metric_id + self.metric_type = metric_type + self.scenario_maql = scenario_maql + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-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_measure_adjustment_config.pyi b/gooddata-api-client/gooddata_api_client/model/what_if_measure_adjustment_config.pyi new file mode 100644 index 000000000..5b09cca29 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/what_if_measure_adjustment_config.pyi @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class WhatIfMeasureAdjustmentConfig( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Measure adjustments for this scenario + """ + + + class MetaOapg: + required = { + "metricType", + "metricId", + "scenarioMaql", + } + + class properties: + metricId = schemas.StrSchema + metricType = schemas.StrSchema + scenarioMaql = schemas.StrSchema + __annotations__ = { + "metricId": metricId, + "metricType": metricType, + "scenarioMaql": scenarioMaql, + } + + metricType: MetaOapg.properties.metricType + metricId: MetaOapg.properties.metricId + scenarioMaql: MetaOapg.properties.scenarioMaql + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metricId"]) -> MetaOapg.properties.metricId: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["metricType"]) -> MetaOapg.properties.metricType: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["scenarioMaql"]) -> MetaOapg.properties.scenarioMaql: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["metricId", "metricType", "scenarioMaql", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metricId"]) -> MetaOapg.properties.metricId: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["metricType"]) -> MetaOapg.properties.metricType: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["scenarioMaql"]) -> MetaOapg.properties.scenarioMaql: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["metricId", "metricType", "scenarioMaql", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + metricType: typing.Union[MetaOapg.properties.metricType, str, ], + metricId: typing.Union[MetaOapg.properties.metricId, str, ], + scenarioMaql: typing.Union[MetaOapg.properties.scenarioMaql, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'WhatIfMeasureAdjustmentConfig': + return super().__new__( + cls, + *_args, + metricType=metricType, + metricId=metricId, + scenarioMaql=scenarioMaql, + _configuration=_configuration, + **kwargs, + ) 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 new file mode 100644 index 000000000..c1d64c60d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/what_if_scenario_config.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.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_config.pyi b/gooddata-api-client/gooddata_api_client/model/what_if_scenario_config.pyi new file mode 100644 index 000000000..8bb6e3ac0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/what_if_scenario_config.pyi @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class WhatIfScenarioConfig( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + What-if scenario configuration. + """ + + + class MetaOapg: + required = { + "includeBaseline", + "scenarios", + } + + class properties: + includeBaseline = schemas.BoolSchema + + + class scenarios( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['WhatIfScenarioItem']: + return WhatIfScenarioItem + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['WhatIfScenarioItem'], typing.List['WhatIfScenarioItem']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'scenarios': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'WhatIfScenarioItem': + return super().__getitem__(i) + __annotations__ = { + "includeBaseline": includeBaseline, + "scenarios": scenarios, + } + + includeBaseline: MetaOapg.properties.includeBaseline + scenarios: MetaOapg.properties.scenarios + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["includeBaseline"]) -> MetaOapg.properties.includeBaseline: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["scenarios"]) -> MetaOapg.properties.scenarios: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["includeBaseline", "scenarios", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["includeBaseline"]) -> MetaOapg.properties.includeBaseline: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["scenarios"]) -> MetaOapg.properties.scenarios: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["includeBaseline", "scenarios", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + includeBaseline: typing.Union[MetaOapg.properties.includeBaseline, bool, ], + scenarios: typing.Union[MetaOapg.properties.scenarios, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'WhatIfScenarioConfig': + return super().__new__( + cls, + *_args, + includeBaseline=includeBaseline, + scenarios=scenarios, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.what_if_scenario_item import WhatIfScenarioItem 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 new file mode 100644 index 000000000..41160fcfa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/what_if_scenario_item.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.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/what_if_scenario_item.pyi b/gooddata-api-client/gooddata_api_client/model/what_if_scenario_item.pyi new file mode 100644 index 000000000..af61d2dc6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/what_if_scenario_item.pyi @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class WhatIfScenarioItem( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Scenarios with alternative measure calculations + """ + + + class MetaOapg: + required = { + "adjustments", + "label", + } + + class properties: + + + class adjustments( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['WhatIfMeasureAdjustmentConfig']: + return WhatIfMeasureAdjustmentConfig + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['WhatIfMeasureAdjustmentConfig'], typing.List['WhatIfMeasureAdjustmentConfig']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'adjustments': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'WhatIfMeasureAdjustmentConfig': + return super().__getitem__(i) + label = schemas.StrSchema + __annotations__ = { + "adjustments": adjustments, + "label": label, + } + + adjustments: MetaOapg.properties.adjustments + label: MetaOapg.properties.label + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["adjustments"]) -> MetaOapg.properties.adjustments: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["label"]) -> MetaOapg.properties.label: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["adjustments", "label", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["adjustments"]) -> MetaOapg.properties.adjustments: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["label"]) -> MetaOapg.properties.label: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["adjustments", "label", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + adjustments: typing.Union[MetaOapg.properties.adjustments, list, tuple, ], + label: typing.Union[MetaOapg.properties.label, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'WhatIfScenarioItem': + return super().__new__( + cls, + *_args, + adjustments=adjustments, + label=label, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.what_if_measure_adjustment_config import WhatIfMeasureAdjustmentConfig diff --git a/gooddata-api-client/gooddata_api_client/model/widget_slides_template.pyi b/gooddata-api-client/gooddata_api_client/model/widget_slides_template.pyi new file mode 100644 index 000000000..f5a77e268 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/widget_slides_template.pyi @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class WidgetSlidesTemplate( + schemas.DictBase, + schemas.NoneBase, + schemas.Schema, + schemas.NoneFrozenDictMixin +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Template for widget slides export. +Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + """ + + + class MetaOapg: + required = { + "appliedOn", + } + + class properties: + + + class appliedOn( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PDF(cls): + return cls("PDF") + + @schemas.classproperty + def PPTX(cls): + return cls("PPTX") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'appliedOn': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + @staticmethod + def contentSlide() -> typing.Type['ContentSlideTemplate']: + return ContentSlideTemplate + __annotations__ = { + "appliedOn": appliedOn, + "contentSlide": contentSlide, + } + + + appliedOn: MetaOapg.properties.appliedOn + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["contentSlide"]) -> 'ContentSlideTemplate': ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["appliedOn"]) -> MetaOapg.properties.appliedOn: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["contentSlide"]) -> typing.Union['ContentSlideTemplate', schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["appliedOn", "contentSlide", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, None, ], + contentSlide: typing.Union['ContentSlideTemplate', schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'WidgetSlidesTemplate': + return super().__new__( + cls, + *_args, + contentSlide=contentSlide, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.content_slide_template import ContentSlideTemplate diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_automation_identifier.pyi b/gooddata-api-client/gooddata_api_client/model/workspace_automation_identifier.pyi new file mode 100644 index 000000000..de6b9a344 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/workspace_automation_identifier.pyi @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class WorkspaceAutomationIdentifier( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "id", + } + + class properties: + id = schemas.StrSchema + __annotations__ = { + "id": id, + } + + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'WorkspaceAutomationIdentifier': + return super().__new__( + cls, + *_args, + id=id, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_automation_management_bulk_request.pyi b/gooddata-api-client/gooddata_api_client/model/workspace_automation_management_bulk_request.pyi new file mode 100644 index 000000000..20521b585 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/workspace_automation_management_bulk_request.pyi @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class WorkspaceAutomationManagementBulkRequest( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "automations", + } + + class properties: + + + class automations( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['WorkspaceAutomationIdentifier']: + return WorkspaceAutomationIdentifier + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['WorkspaceAutomationIdentifier'], typing.List['WorkspaceAutomationIdentifier']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'automations': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'WorkspaceAutomationIdentifier': + return super().__getitem__(i) + __annotations__ = { + "automations": automations, + } + + automations: MetaOapg.properties.automations + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["automations"]) -> MetaOapg.properties.automations: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["automations", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["automations"]) -> MetaOapg.properties.automations: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["automations", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + automations: typing.Union[MetaOapg.properties.automations, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'WorkspaceAutomationManagementBulkRequest': + return super().__new__( + cls, + *_args, + automations=automations, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.workspace_automation_identifier import WorkspaceAutomationIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_data_source.pyi b/gooddata-api-client/gooddata_api_client/model/workspace_data_source.pyi new file mode 100644 index 000000000..9140e0efb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/workspace_data_source.pyi @@ -0,0 +1,118 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class WorkspaceDataSource( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + 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. + """ + + + class MetaOapg: + required = { + "id", + } + + class properties: + id = schemas.StrSchema + + + class schemaPath( + schemas.ListSchema + ): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'schemaPath': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "id": id, + "schemaPath": schemaPath, + } + + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["schemaPath"]) -> MetaOapg.properties.schemaPath: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "schemaPath", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["schemaPath"]) -> typing.Union[MetaOapg.properties.schemaPath, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "schemaPath", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + schemaPath: typing.Union[MetaOapg.properties.schemaPath, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'WorkspaceDataSource': + return super().__new__( + cls, + *_args, + id=id, + schemaPath=schemaPath, + _configuration=_configuration, + **kwargs, + ) 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 6b463d1af..e92fb6422 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 @@ -68,6 +68,8 @@ class WorkspacePermissionAssignment(ModelNormal): 'EXPORT_PDF': "EXPORT_PDF", 'CREATE_AUTOMATION': "CREATE_AUTOMATION", 'USE_AI_ASSISTANT': "USE_AI_ASSISTANT", + 'WRITE_KNOWLEDGE_DOCUMENTS': "WRITE_KNOWLEDGE_DOCUMENTS", + 'READ_KNOWLEDGE_DOCUMENTS': "READ_KNOWLEDGE_DOCUMENTS", 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", 'VIEW': "VIEW", }, @@ -79,6 +81,8 @@ class WorkspacePermissionAssignment(ModelNormal): 'EXPORT_PDF': "EXPORT_PDF", 'CREATE_AUTOMATION': "CREATE_AUTOMATION", 'USE_AI_ASSISTANT': "USE_AI_ASSISTANT", + 'WRITE_KNOWLEDGE_DOCUMENTS': "WRITE_KNOWLEDGE_DOCUMENTS", + 'READ_KNOWLEDGE_DOCUMENTS': "READ_KNOWLEDGE_DOCUMENTS", 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", 'VIEW': "VIEW", }, diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_permission_assignment.pyi b/gooddata-api-client/gooddata_api_client/model/workspace_permission_assignment.pyi new file mode 100644 index 000000000..4f990f859 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/workspace_permission_assignment.pyi @@ -0,0 +1,253 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class WorkspacePermissionAssignment( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Workspace permission assignments + """ + + + class MetaOapg: + required = { + "assigneeIdentifier", + } + + class properties: + + @staticmethod + def assigneeIdentifier() -> typing.Type['AssigneeIdentifier']: + return AssigneeIdentifier + + + class hierarchyPermissions( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MANAGE(cls): + return cls("MANAGE") + + @schemas.classproperty + def ANALYZE(cls): + return cls("ANALYZE") + + @schemas.classproperty + def EXPORT(cls): + return cls("EXPORT") + + @schemas.classproperty + def EXPORT_TABULAR(cls): + return cls("EXPORT_TABULAR") + + @schemas.classproperty + def EXPORT_PDF(cls): + return cls("EXPORT_PDF") + + @schemas.classproperty + def CREATE_AUTOMATION(cls): + return cls("CREATE_AUTOMATION") + + @schemas.classproperty + def USE_AI_ASSISTANT(cls): + return cls("USE_AI_ASSISTANT") + + @schemas.classproperty + def WRITE_KNOWLEDGE_DOCUMENTS(cls): + return cls("WRITE_KNOWLEDGE_DOCUMENTS") + + @schemas.classproperty + def READ_KNOWLEDGE_DOCUMENTS(cls): + return cls("READ_KNOWLEDGE_DOCUMENTS") + + @schemas.classproperty + def CREATE_FILTER_VIEW(cls): + return cls("CREATE_FILTER_VIEW") + + @schemas.classproperty + def VIEW(cls): + return cls("VIEW") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'hierarchyPermissions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + + class permissions( + schemas.ListSchema + ): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def MANAGE(cls): + return cls("MANAGE") + + @schemas.classproperty + def ANALYZE(cls): + return cls("ANALYZE") + + @schemas.classproperty + def EXPORT(cls): + return cls("EXPORT") + + @schemas.classproperty + def EXPORT_TABULAR(cls): + return cls("EXPORT_TABULAR") + + @schemas.classproperty + def EXPORT_PDF(cls): + return cls("EXPORT_PDF") + + @schemas.classproperty + def CREATE_AUTOMATION(cls): + return cls("CREATE_AUTOMATION") + + @schemas.classproperty + def USE_AI_ASSISTANT(cls): + return cls("USE_AI_ASSISTANT") + + @schemas.classproperty + def WRITE_KNOWLEDGE_DOCUMENTS(cls): + return cls("WRITE_KNOWLEDGE_DOCUMENTS") + + @schemas.classproperty + def READ_KNOWLEDGE_DOCUMENTS(cls): + return cls("READ_KNOWLEDGE_DOCUMENTS") + + @schemas.classproperty + def CREATE_FILTER_VIEW(cls): + return cls("CREATE_FILTER_VIEW") + + @schemas.classproperty + def VIEW(cls): + return cls("VIEW") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'permissions': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + __annotations__ = { + "assigneeIdentifier": assigneeIdentifier, + "hierarchyPermissions": hierarchyPermissions, + "permissions": permissions, + } + + assigneeIdentifier: 'AssigneeIdentifier' + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["assigneeIdentifier"]) -> 'AssigneeIdentifier': ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["hierarchyPermissions"]) -> MetaOapg.properties.hierarchyPermissions: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["permissions"]) -> MetaOapg.properties.permissions: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["assigneeIdentifier", "hierarchyPermissions", "permissions", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["assigneeIdentifier"]) -> 'AssigneeIdentifier': ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["hierarchyPermissions"]) -> typing.Union[MetaOapg.properties.hierarchyPermissions, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["permissions"]) -> typing.Union[MetaOapg.properties.permissions, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["assigneeIdentifier", "hierarchyPermissions", "permissions", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + assigneeIdentifier: 'AssigneeIdentifier', + hierarchyPermissions: typing.Union[MetaOapg.properties.hierarchyPermissions, list, tuple, schemas.Unset] = schemas.unset, + permissions: typing.Union[MetaOapg.properties.permissions, list, tuple, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'WorkspacePermissionAssignment': + return super().__new__( + cls, + *_args, + assigneeIdentifier=assigneeIdentifier, + hierarchyPermissions=hierarchyPermissions, + permissions=permissions, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_user.pyi b/gooddata-api-client/gooddata_api_client/model/workspace_user.pyi new file mode 100644 index 000000000..16c8d5194 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/workspace_user.pyi @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class WorkspaceUser( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + List of workspace users + """ + + + class MetaOapg: + required = { + "id", + } + + class properties: + id = schemas.StrSchema + email = schemas.StrSchema + name = schemas.StrSchema + __annotations__ = { + "id": id, + "email": email, + "name": name, + } + + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["email"]) -> MetaOapg.properties.email: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "email", "name", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["email"]) -> typing.Union[MetaOapg.properties.email, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "email", "name", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + email: typing.Union[MetaOapg.properties.email, str, schemas.Unset] = schemas.unset, + name: typing.Union[MetaOapg.properties.name, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'WorkspaceUser': + return super().__new__( + cls, + *_args, + id=id, + email=email, + name=name, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_user_group.pyi b/gooddata-api-client/gooddata_api_client/model/workspace_user_group.pyi new file mode 100644 index 000000000..3e418f17a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/workspace_user_group.pyi @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class WorkspaceUserGroup( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + List of workspace groups + """ + + + class MetaOapg: + required = { + "id", + } + + class properties: + id = schemas.StrSchema + name = schemas.StrSchema + __annotations__ = { + "id": id, + "name": name, + } + + id: MetaOapg.properties.id + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["name"]) -> MetaOapg.properties.name: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["id", "name", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["name"]) -> typing.Union[MetaOapg.properties.name, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["id", "name", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + id: typing.Union[MetaOapg.properties.id, str, ], + name: typing.Union[MetaOapg.properties.name, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'WorkspaceUserGroup': + return super().__new__( + cls, + *_args, + id=id, + name=name, + _configuration=_configuration, + **kwargs, + ) diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_user_groups.pyi b/gooddata-api-client/gooddata_api_client/model/workspace_user_groups.pyi new file mode 100644 index 000000000..99d566b19 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/workspace_user_groups.pyi @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class WorkspaceUserGroups( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "userGroups", + "totalCount", + } + + class properties: + totalCount = schemas.Int32Schema + + + class userGroups( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['WorkspaceUserGroup']: + return WorkspaceUserGroup + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['WorkspaceUserGroup'], typing.List['WorkspaceUserGroup']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'userGroups': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'WorkspaceUserGroup': + return super().__getitem__(i) + __annotations__ = { + "totalCount": totalCount, + "userGroups": userGroups, + } + + userGroups: MetaOapg.properties.userGroups + totalCount: MetaOapg.properties.totalCount + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["totalCount"]) -> MetaOapg.properties.totalCount: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["totalCount", "userGroups", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["totalCount"]) -> MetaOapg.properties.totalCount: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["userGroups"]) -> MetaOapg.properties.userGroups: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["totalCount", "userGroups", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + userGroups: typing.Union[MetaOapg.properties.userGroups, list, tuple, ], + totalCount: typing.Union[MetaOapg.properties.totalCount, decimal.Decimal, int, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'WorkspaceUserGroups': + return super().__new__( + cls, + *_args, + userGroups=userGroups, + totalCount=totalCount, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.workspace_user_group import WorkspaceUserGroup diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_users.pyi b/gooddata-api-client/gooddata_api_client/model/workspace_users.pyi new file mode 100644 index 000000000..99c39c46e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/workspace_users.pyi @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class WorkspaceUsers( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + required = { + "totalCount", + "users", + } + + class properties: + totalCount = schemas.Int32Schema + + + class users( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['WorkspaceUser']: + return WorkspaceUser + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['WorkspaceUser'], typing.List['WorkspaceUser']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'users': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'WorkspaceUser': + return super().__getitem__(i) + __annotations__ = { + "totalCount": totalCount, + "users": users, + } + + totalCount: MetaOapg.properties.totalCount + users: MetaOapg.properties.users + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["totalCount"]) -> MetaOapg.properties.totalCount: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["totalCount", "users", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["totalCount"]) -> MetaOapg.properties.totalCount: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["users"]) -> MetaOapg.properties.users: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["totalCount", "users", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + totalCount: typing.Union[MetaOapg.properties.totalCount, decimal.Decimal, int, ], + users: typing.Union[MetaOapg.properties.users, list, tuple, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'WorkspaceUsers': + return super().__new__( + cls, + *_args, + totalCount=totalCount, + users=users, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.workspace_user import WorkspaceUser diff --git a/gooddata-api-client/gooddata_api_client/model/xliff.pyi b/gooddata-api-client/gooddata_api_client/model/xliff.pyi new file mode 100644 index 000000000..39970109a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/xliff.pyi @@ -0,0 +1,184 @@ +# coding: utf-8 + +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + +class Xliff( + schemas.DictSchema +): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + + class MetaOapg: + + class properties: + + + class file( + schemas.ListSchema + ): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['File']: + return File + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['File'], typing.List['File']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'file': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'File': + return super().__getitem__(i) + + + class otherAttributes( + schemas.DictSchema + ): + + + class MetaOapg: + additional_properties = schemas.StrSchema + + def __getitem__(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + # dict_instance[name] accessor + return super().__getitem__(name) + + def get_item_oapg(self, name: typing.Union[str, ]) -> MetaOapg.additional_properties: + return super().get_item_oapg(name) + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[MetaOapg.additional_properties, str, ], + ) -> 'otherAttributes': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + space = schemas.StrSchema + srcLang = schemas.StrSchema + trgLang = schemas.StrSchema + version = schemas.StrSchema + __annotations__ = { + "file": file, + "otherAttributes": otherAttributes, + "space": space, + "srcLang": srcLang, + "trgLang": trgLang, + "version": version, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["file"]) -> MetaOapg.properties.file: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["otherAttributes"]) -> MetaOapg.properties.otherAttributes: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["space"]) -> MetaOapg.properties.space: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["srcLang"]) -> MetaOapg.properties.srcLang: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["trgLang"]) -> MetaOapg.properties.trgLang: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["version"]) -> MetaOapg.properties.version: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["file", "otherAttributes", "space", "srcLang", "trgLang", "version", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["file"]) -> typing.Union[MetaOapg.properties.file, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["otherAttributes"]) -> typing.Union[MetaOapg.properties.otherAttributes, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["space"]) -> typing.Union[MetaOapg.properties.space, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["srcLang"]) -> typing.Union[MetaOapg.properties.srcLang, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["trgLang"]) -> typing.Union[MetaOapg.properties.trgLang, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["version"]) -> typing.Union[MetaOapg.properties.version, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["file", "otherAttributes", "space", "srcLang", "trgLang", "version", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + file: typing.Union[MetaOapg.properties.file, list, tuple, schemas.Unset] = schemas.unset, + otherAttributes: typing.Union[MetaOapg.properties.otherAttributes, dict, frozendict.frozendict, schemas.Unset] = schemas.unset, + space: typing.Union[MetaOapg.properties.space, str, schemas.Unset] = schemas.unset, + srcLang: typing.Union[MetaOapg.properties.srcLang, str, schemas.Unset] = schemas.unset, + trgLang: typing.Union[MetaOapg.properties.trgLang, str, schemas.Unset] = schemas.unset, + version: typing.Union[MetaOapg.properties.version, str, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'Xliff': + return super().__new__( + cls, + *_args, + file=file, + otherAttributes=otherAttributes, + space=space, + srcLang=srcLang, + trgLang=trgLang, + version=version, + _configuration=_configuration, + **kwargs, + ) + +from gooddata_api_client.model.file import File diff --git a/gooddata-api-client/gooddata_api_client/model_utils.py b/gooddata-api-client/gooddata_api_client/model_utils.py index bc91bd70e..78d2b33f0 100644 --- a/gooddata-api-client/gooddata_api_client/model_utils.py +++ b/gooddata-api-client/gooddata_api_client/model_utils.py @@ -204,7 +204,7 @@ def __deepcopy__(self, memo): if self.get("_spec_property_naming", False): new_inst = cls._new_from_openapi_data() else: - new_inst = cls.__new__(cls) + new_inst = cls.__new__(cls, **self.__dict__) for k, v in self.__dict__.items(): setattr(new_inst, k, deepcopy(v, memo)) diff --git a/gooddata-api-client/gooddata_api_client/models/__init__.py b/gooddata-api-client/gooddata_api_client/models/__init__.py index 6182a310b..2ff91ad33 100644 --- a/gooddata-api-client/gooddata_api_client/models/__init__.py +++ b/gooddata-api-client/gooddata_api_client/models/__init__.py @@ -4,7 +4,7 @@ # if you have many models here with many references from one model to another this may # raise a RecursionError # to avoid this, import only the models that you directly need like: -# from from gooddata_api_client.model.pet import Pet +# from gooddata_api_client.model.pet import Pet # or import this package, but before doing it, use: # import sys # sys.setrecursionlimit(n) @@ -59,8 +59,6 @@ from gooddata_api_client.model.aac_workspace_data_filter import AacWorkspaceDataFilter from gooddata_api_client.model.absolute_date_filter import AbsoluteDateFilter from gooddata_api_client.model.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter -from gooddata_api_client.model.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.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 @@ -88,11 +86,14 @@ from gooddata_api_client.model.alert_condition_operand import AlertConditionOperand from gooddata_api_client.model.alert_description import AlertDescription 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.analytics_catalog_created_by import AnalyticsCatalogCreatedBy from gooddata_api_client.model.analytics_catalog_tags import AnalyticsCatalogTags from gooddata_api_client.model.analytics_catalog_user import AnalyticsCatalogUser 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 @@ -134,6 +135,14 @@ from gooddata_api_client.model.automation_tabular_export import AutomationTabularExport from gooddata_api_client.model.automation_visual_export import AutomationVisualExport from gooddata_api_client.model.available_assignees import AvailableAssignees +from gooddata_api_client.model.aws_bedrock_access_key_auth import AwsBedrockAccessKeyAuth +from gooddata_api_client.model.aws_bedrock_access_key_auth_all_of import AwsBedrockAccessKeyAuthAllOf +from gooddata_api_client.model.aws_bedrock_provider_config import AwsBedrockProviderConfig +from gooddata_api_client.model.azure_foundry_api_key_auth import AzureFoundryApiKeyAuth +from gooddata_api_client.model.azure_foundry_api_key_auth_all_of import AzureFoundryApiKeyAuthAllOf +from gooddata_api_client.model.azure_foundry_provider_auth import AzureFoundryProviderAuth +from gooddata_api_client.model.azure_foundry_provider_config import AzureFoundryProviderConfig +from gooddata_api_client.model.bedrock_provider_auth import BedrockProviderAuth from gooddata_api_client.model.bounded_filter import BoundedFilter from gooddata_api_client.model.change_analysis_params import ChangeAnalysisParams from gooddata_api_client.model.change_analysis_params_filters_inner import ChangeAnalysisParamsFiltersInner @@ -146,6 +155,7 @@ 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_location import ColumnLocation @@ -166,6 +176,8 @@ from gooddata_api_client.model.compound_measure_value_filter_compound_measure_value_filter import CompoundMeasureValueFilterCompoundMeasureValueFilter from gooddata_api_client.model.content_slide_template import ContentSlideTemplate from gooddata_api_client.model.cover_slide_template import CoverSlideTemplate +from gooddata_api_client.model.create_knowledge_document_request_dto import CreateKnowledgeDocumentRequestDto +from gooddata_api_client.model.create_knowledge_document_response_dto import CreateKnowledgeDocumentResponseDto 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 @@ -289,6 +301,7 @@ from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces from gooddata_api_client.model.default_smtp import DefaultSmtp from gooddata_api_client.model.default_smtp_all_of import DefaultSmtpAllOf +from gooddata_api_client.model.delete_knowledge_document_response_dto import DeleteKnowledgeDocumentResponseDto from gooddata_api_client.model.dependent_entities_graph import DependentEntitiesGraph from gooddata_api_client.model.dependent_entities_node import DependentEntitiesNode from gooddata_api_client.model.dependent_entities_request import DependentEntitiesRequest @@ -330,13 +343,18 @@ 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.forecast_config import ForecastConfig 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.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 +from gooddata_api_client.model.generate_title_request import GenerateTitleRequest +from gooddata_api_client.model.generate_title_response import GenerateTitleResponse from gooddata_api_client.model.geo_area_config import GeoAreaConfig from gooddata_api_client.model.geo_collection_identifier import GeoCollectionIdentifier from gooddata_api_client.model.get_ai_lake_operation200_response import GetAiLakeOperation200Response @@ -388,7 +406,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_created_by import JsonApiAnalyticalDashboardOutRelationshipsCreatedBy +from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_certified_by import JsonApiAnalyticalDashboardOutRelationshipsCertifiedBy 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 @@ -722,6 +740,18 @@ from gooddata_api_client.model.json_api_llm_endpoint_patch import JsonApiLlmEndpointPatch from gooddata_api_client.model.json_api_llm_endpoint_patch_attributes import JsonApiLlmEndpointPatchAttributes from gooddata_api_client.model.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument +from gooddata_api_client.model.json_api_llm_provider_in import JsonApiLlmProviderIn +from gooddata_api_client.model.json_api_llm_provider_in_attributes import JsonApiLlmProviderInAttributes +from gooddata_api_client.model.json_api_llm_provider_in_attributes_models_inner import JsonApiLlmProviderInAttributesModelsInner +from gooddata_api_client.model.json_api_llm_provider_in_attributes_provider_config import JsonApiLlmProviderInAttributesProviderConfig +from gooddata_api_client.model.json_api_llm_provider_in_document import JsonApiLlmProviderInDocument +from gooddata_api_client.model.json_api_llm_provider_out import JsonApiLlmProviderOut +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument +from gooddata_api_client.model.json_api_llm_provider_out_list import JsonApiLlmProviderOutList +from gooddata_api_client.model.json_api_llm_provider_out_with_links import JsonApiLlmProviderOutWithLinks +from gooddata_api_client.model.json_api_llm_provider_patch import JsonApiLlmProviderPatch +from gooddata_api_client.model.json_api_llm_provider_patch_attributes import JsonApiLlmProviderPatchAttributes +from gooddata_api_client.model.json_api_llm_provider_patch_document import JsonApiLlmProviderPatchDocument from gooddata_api_client.model.json_api_memory_item_in import JsonApiMemoryItemIn from gooddata_api_client.model.json_api_memory_item_in_attributes import JsonApiMemoryItemInAttributes from gooddata_api_client.model.json_api_memory_item_in_document import JsonApiMemoryItemInDocument @@ -943,9 +973,15 @@ from gooddata_api_client.model.key_drivers_request import KeyDriversRequest from gooddata_api_client.model.key_drivers_response import KeyDriversResponse from gooddata_api_client.model.key_drivers_result import KeyDriversResult +from gooddata_api_client.model.knowledge_document_metadata_dto import KnowledgeDocumentMetadataDto +from gooddata_api_client.model.knowledge_search_result_dto import KnowledgeSearchResultDto from gooddata_api_client.model.label_identifier import LabelIdentifier +from gooddata_api_client.model.list_knowledge_documents_response_dto import ListKnowledgeDocumentsResponseDto from gooddata_api_client.model.list_links import ListLinks from gooddata_api_client.model.list_links_all_of import ListLinksAllOf +from gooddata_api_client.model.llm_model import LlmModel +from gooddata_api_client.model.llm_provider_auth import LlmProviderAuth +from gooddata_api_client.model.llm_provider_config import LlmProviderConfig from gooddata_api_client.model.local_identifier import LocalIdentifier from gooddata_api_client.model.locale_request import LocaleRequest from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner @@ -963,8 +999,10 @@ 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_record import MetricRecord from gooddata_api_client.model.metric_value_change import MetricValueChange +from gooddata_api_client.model.model_test_result import ModelTestResult from gooddata_api_client.model.negative_attribute_filter import NegativeAttributeFilter from gooddata_api_client.model.negative_attribute_filter_negative_attribute_filter import NegativeAttributeFilterNegativeAttributeFilter from gooddata_api_client.model.note import Note @@ -979,6 +1017,10 @@ from gooddata_api_client.model.notifications_meta_total import NotificationsMetaTotal from gooddata_api_client.model.object_links import ObjectLinks from gooddata_api_client.model.object_links_container import ObjectLinksContainer +from gooddata_api_client.model.open_ai_provider_config import OpenAIProviderConfig +from gooddata_api_client.model.open_ai_api_key_auth import OpenAiApiKeyAuth +from gooddata_api_client.model.open_ai_api_key_auth_all_of import OpenAiApiKeyAuthAllOf +from gooddata_api_client.model.open_ai_provider_auth import OpenAiProviderAuth from gooddata_api_client.model.operation import Operation from gooddata_api_client.model.operation_error import OperationError from gooddata_api_client.model.organization_automation_identifier import OrganizationAutomationIdentifier @@ -991,6 +1033,7 @@ from gooddata_api_client.model.page_metadata import PageMetadata from gooddata_api_client.model.paging import Paging from gooddata_api_client.model.parameter import Parameter +from gooddata_api_client.model.patch_knowledge_document_request_dto import PatchKnowledgeDocumentRequestDto 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 @@ -1049,17 +1092,22 @@ 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.search_knowledge_response_dto import SearchKnowledgeResponseDto 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.search_statistics_dto import SearchStatisticsDto 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 from gooddata_api_client.model.settings import Settings from gooddata_api_client.model.simple_measure_definition import SimpleMeasureDefinition from gooddata_api_client.model.simple_measure_definition_measure import SimpleMeasureDefinitionMeasure @@ -1089,6 +1137,9 @@ from gooddata_api_client.model.tabular_export_request import TabularExportRequest from gooddata_api_client.model.test_definition_request import TestDefinitionRequest from gooddata_api_client.model.test_destination_request import TestDestinationRequest +from gooddata_api_client.model.test_llm_provider_definition_request import TestLlmProviderDefinitionRequest +from gooddata_api_client.model.test_llm_provider_definition_request_provider_config import TestLlmProviderDefinitionRequestProviderConfig +from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse from gooddata_api_client.model.test_notification import TestNotification from gooddata_api_client.model.test_notification_all_of import TestNotificationAllOf from gooddata_api_client.model.test_query_duration import TestQueryDuration @@ -1101,6 +1152,8 @@ from gooddata_api_client.model.total_result_header import TotalResultHeader 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.upsert_knowledge_document_request_dto import UpsertKnowledgeDocumentRequestDto +from gooddata_api_client.model.upsert_knowledge_document_response_dto import UpsertKnowledgeDocumentResponseDto 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 @@ -1123,12 +1176,16 @@ 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.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_slides_template import WidgetSlidesTemplate from gooddata_api_client.model.workspace_automation_identifier import WorkspaceAutomationIdentifier from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_analytics_model/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_analytics_model/__init__.py new file mode 100644 index 000000000..8d4dd67e6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_analytics_model/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_aac_workspaces_workspace_id_analytics_model import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_AAC_WORKSPACES_WORKSPACE_ID_ANALYTICS_MODEL \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_analytics_model/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_analytics_model/get.py new file mode 100644 index 000000000..59176f755 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_analytics_model/get.py @@ -0,0 +1,384 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.aac_analytics_model import AacAnalyticsModel + +from . import path + +# Query params + + +class ExcludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "ACTIVITY_INFO": "ACTIVITY_INFO", + } + + @schemas.classproperty + def ACTIVITY_INFO(cls): + return cls("ACTIVITY_INFO") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ExcludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'exclude': typing.Union[ExcludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_exclude = api_client.QueryParameter( + name="exclude", + style=api_client.ParameterStyle.FORM, + schema=ExcludeSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = AacAnalyticsModel + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_analytics_model_aac_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_analytics_model_aac_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_analytics_model_aac_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_analytics_model_aac_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get analytics model in AAC format + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_exclude, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAnalyticsModelAac(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_analytics_model_aac( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_analytics_model_aac( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_analytics_model_aac( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_analytics_model_aac( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_analytics_model_aac_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_analytics_model_aac_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_analytics_model/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_analytics_model/get.pyi new file mode 100644 index 000000000..7786c6775 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_analytics_model/get.pyi @@ -0,0 +1,373 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.aac_analytics_model import AacAnalyticsModel + +# Query params + + +class ExcludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ACTIVITY_INFO(cls): + return cls("ACTIVITY_INFO") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ExcludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'exclude': typing.Union[ExcludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_exclude = api_client.QueryParameter( + name="exclude", + style=api_client.ParameterStyle.FORM, + schema=ExcludeSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = AacAnalyticsModel + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_analytics_model_aac_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_analytics_model_aac_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_analytics_model_aac_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_analytics_model_aac_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get analytics model in AAC format + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_exclude, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAnalyticsModelAac(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_analytics_model_aac( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_analytics_model_aac( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_analytics_model_aac( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_analytics_model_aac( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_analytics_model_aac_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_analytics_model_aac_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_analytics_model/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_analytics_model/put.py new file mode 100644 index 000000000..ae521fdf0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_analytics_model/put.py @@ -0,0 +1,360 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.aac_analytics_model import AacAnalyticsModel + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = AacAnalyticsModel + + +request_body_aac_analytics_model = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _set_analytics_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_analytics_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_analytics_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_analytics_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_analytics_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set analytics model from AAC format + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_aac_analytics_model.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetAnalyticsModelAac(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_analytics_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_analytics_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_analytics_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_analytics_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_analytics_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_analytics_model_aac_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_analytics_model_aac_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_analytics_model/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_analytics_model/put.pyi new file mode 100644 index 000000000..56b4d26d8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_analytics_model/put.pyi @@ -0,0 +1,355 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.aac_analytics_model import AacAnalyticsModel + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = AacAnalyticsModel + + +request_body_aac_analytics_model = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _set_analytics_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_analytics_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_analytics_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_analytics_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_analytics_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set analytics model from AAC format + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_aac_analytics_model.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetAnalyticsModelAac(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_analytics_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_analytics_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_analytics_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_analytics_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_analytics_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_analytics_model_aac_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_analytics_model_aac_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_logical_model/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_logical_model/__init__.py new file mode 100644 index 000000000..9b8425048 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_logical_model/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_aac_workspaces_workspace_id_logical_model import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_AAC_WORKSPACES_WORKSPACE_ID_LOGICAL_MODEL \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_logical_model/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_logical_model/get.py new file mode 100644 index 000000000..2690d56ca --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_logical_model/get.py @@ -0,0 +1,347 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.aac_logical_model import AacLogicalModel + +from . import path + +# Query params +IncludeParentsSchema = schemas.BoolSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'includeParents': typing.Union[IncludeParentsSchema, bool, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_include_parents = api_client.QueryParameter( + name="includeParents", + style=api_client.ParameterStyle.FORM, + schema=IncludeParentsSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = AacLogicalModel + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_logical_model_aac_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_logical_model_aac_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_logical_model_aac_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_logical_model_aac_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get logical model in AAC format + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_include_parents, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetLogicalModelAac(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_logical_model_aac( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_logical_model_aac( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_logical_model_aac( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_logical_model_aac( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_logical_model_aac_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_logical_model_aac_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_logical_model/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_logical_model/get.pyi new file mode 100644 index 000000000..04394c403 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_logical_model/get.pyi @@ -0,0 +1,342 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.aac_logical_model import AacLogicalModel + +# Query params +IncludeParentsSchema = schemas.BoolSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'includeParents': typing.Union[IncludeParentsSchema, bool, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_include_parents = api_client.QueryParameter( + name="includeParents", + style=api_client.ParameterStyle.FORM, + schema=IncludeParentsSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = AacLogicalModel + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_logical_model_aac_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_logical_model_aac_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_logical_model_aac_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_logical_model_aac_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get logical model in AAC format + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_include_parents, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetLogicalModelAac(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_logical_model_aac( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_logical_model_aac( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_logical_model_aac( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_logical_model_aac( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_logical_model_aac_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_logical_model_aac_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_logical_model/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_logical_model/put.py new file mode 100644 index 000000000..efdc71e91 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_logical_model/put.py @@ -0,0 +1,360 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.aac_logical_model import AacLogicalModel + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = AacLogicalModel + + +request_body_aac_logical_model = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _set_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set logical model from AAC format + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_aac_logical_model.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetLogicalModelAac(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_logical_model_aac_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_logical_model_aac_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_logical_model/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_logical_model/put.pyi new file mode 100644 index 000000000..f45bc4f01 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_aac_workspaces_workspace_id_logical_model/put.pyi @@ -0,0 +1,355 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.aac_logical_model import AacLogicalModel + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = AacLogicalModel + + +request_body_aac_logical_model = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _set_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set logical model from AAC format + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_aac_logical_model.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetLogicalModelAac(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_logical_model_aac_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_logical_model_aac_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_llm_endpoint_id_test/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_llm_endpoint_id_test/__init__.py new file mode 100644 index 000000000..967c9e446 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_llm_endpoint_id_test/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_ai_llm_endpoint_llm_endpoint_id_test import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_AI_LLM_ENDPOINT_LLM_ENDPOINT_ID_TEST \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_llm_endpoint_id_test/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_llm_endpoint_id_test/post.py new file mode 100644 index 000000000..c62460682 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_llm_endpoint_id_test/post.py @@ -0,0 +1,388 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse +from gooddata_api_client.model.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest + +from . import path + +# Path params +LlmEndpointIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'llmEndpointId': typing.Union[LlmEndpointIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_llm_endpoint_id = api_client.PathParameter( + name="llmEndpointId", + style=api_client.ParameterStyle.SIMPLE, + schema=LlmEndpointIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ValidateLLMEndpointByIdRequest + + +request_body_validate_llm_endpoint_by_id_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, +) +SchemaFor200ResponseBodyApplicationJson = ValidateLLMEndpointResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _validate_llm_endpoint_by_id_oapg( + self, + content_type: typing_extensions.Literal["application/json"] = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _validate_llm_endpoint_by_id_oapg( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _validate_llm_endpoint_by_id_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _validate_llm_endpoint_by_id_oapg( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _validate_llm_endpoint_by_id_oapg( + self, + content_type: str = 'application/json', + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Validate LLM Endpoint By Id + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_llm_endpoint_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + _fields = None + _body = None + if body is not schemas.unset: + serialized_data = request_body_validate_llm_endpoint_by_id_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ValidateLlmEndpointById(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def validate_llm_endpoint_by_id( + self, + content_type: typing_extensions.Literal["application/json"] = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def validate_llm_endpoint_by_id( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def validate_llm_endpoint_by_id( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def validate_llm_endpoint_by_id( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def validate_llm_endpoint_by_id( + self, + content_type: str = 'application/json', + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._validate_llm_endpoint_by_id_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + content_type: typing_extensions.Literal["application/json"] = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + content_type: str = 'application/json', + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._validate_llm_endpoint_by_id_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_llm_endpoint_id_test/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_llm_endpoint_id_test/post.pyi new file mode 100644 index 000000000..a5789e487 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_llm_endpoint_id_test/post.pyi @@ -0,0 +1,383 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse +from gooddata_api_client.model.validate_llm_endpoint_by_id_request import ValidateLLMEndpointByIdRequest + +# Path params +LlmEndpointIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'llmEndpointId': typing.Union[LlmEndpointIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_llm_endpoint_id = api_client.PathParameter( + name="llmEndpointId", + style=api_client.ParameterStyle.SIMPLE, + schema=LlmEndpointIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ValidateLLMEndpointByIdRequest + + +request_body_validate_llm_endpoint_by_id_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, +) +SchemaFor200ResponseBodyApplicationJson = ValidateLLMEndpointResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _validate_llm_endpoint_by_id_oapg( + self, + content_type: typing_extensions.Literal["application/json"] = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _validate_llm_endpoint_by_id_oapg( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _validate_llm_endpoint_by_id_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _validate_llm_endpoint_by_id_oapg( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _validate_llm_endpoint_by_id_oapg( + self, + content_type: str = 'application/json', + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Validate LLM Endpoint By Id + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_llm_endpoint_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + _fields = None + _body = None + if body is not schemas.unset: + serialized_data = request_body_validate_llm_endpoint_by_id_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ValidateLlmEndpointById(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def validate_llm_endpoint_by_id( + self, + content_type: typing_extensions.Literal["application/json"] = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def validate_llm_endpoint_by_id( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def validate_llm_endpoint_by_id( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def validate_llm_endpoint_by_id( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def validate_llm_endpoint_by_id( + self, + content_type: str = 'application/json', + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._validate_llm_endpoint_by_id_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + content_type: typing_extensions.Literal["application/json"] = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + content_type: str = 'application/json', + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._validate_llm_endpoint_by_id_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_test/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_test/__init__.py new file mode 100644 index 000000000..23f6a2a76 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_test/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_ai_llm_endpoint_test import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_AI_LLM_ENDPOINT_TEST \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_test/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_test/post.py new file mode 100644 index 000000000..af4967d92 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_test/post.py @@ -0,0 +1,334 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse +from gooddata_api_client.model.validate_llm_endpoint_request import ValidateLLMEndpointRequest + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = ValidateLLMEndpointRequest + + +request_body_validate_llm_endpoint_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ValidateLLMEndpointResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _validate_llm_endpoint_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _validate_llm_endpoint_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _validate_llm_endpoint_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _validate_llm_endpoint_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _validate_llm_endpoint_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Validate LLM Endpoint + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_validate_llm_endpoint_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ValidateLlmEndpoint(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def validate_llm_endpoint( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def validate_llm_endpoint( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def validate_llm_endpoint( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def validate_llm_endpoint( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def validate_llm_endpoint( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._validate_llm_endpoint_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._validate_llm_endpoint_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_test/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_test/post.pyi new file mode 100644 index 000000000..1479a59b7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_endpoint_test/post.pyi @@ -0,0 +1,329 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.validate_llm_endpoint_response import ValidateLLMEndpointResponse +from gooddata_api_client.model.validate_llm_endpoint_request import ValidateLLMEndpointRequest + +# body param +SchemaForRequestBodyApplicationJson = ValidateLLMEndpointRequest + + +request_body_validate_llm_endpoint_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ValidateLLMEndpointResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _validate_llm_endpoint_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _validate_llm_endpoint_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _validate_llm_endpoint_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _validate_llm_endpoint_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _validate_llm_endpoint_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Validate LLM Endpoint + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_validate_llm_endpoint_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ValidateLlmEndpoint(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def validate_llm_endpoint( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def validate_llm_endpoint( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def validate_llm_endpoint( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def validate_llm_endpoint( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def validate_llm_endpoint( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._validate_llm_endpoint_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._validate_llm_endpoint_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_llm_provider_id_test/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_llm_provider_id_test/__init__.py new file mode 100644 index 000000000..3fc6c8912 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_llm_provider_id_test/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_ai_llm_provider_llm_provider_id_test import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_AI_LLM_PROVIDER_LLM_PROVIDER_ID_TEST \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_llm_provider_id_test/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_llm_provider_id_test/post.py new file mode 100644 index 000000000..d8d6f972f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_llm_provider_id_test/post.py @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse + +from . import path + +# Path params +LlmProviderIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'llmProviderId': typing.Union[LlmProviderIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_llm_provider_id = api_client.PathParameter( + name="llmProviderId", + style=api_client.ParameterStyle.SIMPLE, + schema=LlmProviderIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = TestLlmProviderResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _test_llm_provider_by_id_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _test_llm_provider_by_id_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _test_llm_provider_by_id_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _test_llm_provider_by_id_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Test LLM Provider By Id + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_llm_provider_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class TestLlmProviderById(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def test_llm_provider_by_id( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def test_llm_provider_by_id( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def test_llm_provider_by_id( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def test_llm_provider_by_id( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._test_llm_provider_by_id_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._test_llm_provider_by_id_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_llm_provider_id_test/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_llm_provider_id_test/post.pyi new file mode 100644 index 000000000..1138e686d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_llm_provider_id_test/post.pyi @@ -0,0 +1,288 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse + +# Path params +LlmProviderIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'llmProviderId': typing.Union[LlmProviderIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_llm_provider_id = api_client.PathParameter( + name="llmProviderId", + style=api_client.ParameterStyle.SIMPLE, + schema=LlmProviderIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = TestLlmProviderResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _test_llm_provider_by_id_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _test_llm_provider_by_id_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _test_llm_provider_by_id_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _test_llm_provider_by_id_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Test LLM Provider By Id + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_llm_provider_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class TestLlmProviderById(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def test_llm_provider_by_id( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def test_llm_provider_by_id( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def test_llm_provider_by_id( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def test_llm_provider_by_id( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._test_llm_provider_by_id_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._test_llm_provider_by_id_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_test/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_test/__init__.py new file mode 100644 index 000000000..4786488d1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_test/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_ai_llm_provider_test import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_AI_LLM_PROVIDER_TEST \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_test/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_test/post.py new file mode 100644 index 000000000..7f8ecd4dc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_test/post.py @@ -0,0 +1,334 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse +from gooddata_api_client.model.test_llm_provider_definition_request import TestLlmProviderDefinitionRequest + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = TestLlmProviderDefinitionRequest + + +request_body_test_llm_provider_definition_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = TestLlmProviderResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _test_llm_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _test_llm_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _test_llm_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _test_llm_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _test_llm_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Test LLM Provider + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_test_llm_provider_definition_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class TestLlmProvider(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def test_llm_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def test_llm_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def test_llm_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def test_llm_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def test_llm_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._test_llm_provider_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._test_llm_provider_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_test/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_test/post.pyi new file mode 100644 index 000000000..637612406 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_ai_llm_provider_test/post.pyi @@ -0,0 +1,329 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.test_llm_provider_response import TestLlmProviderResponse +from gooddata_api_client.model.test_llm_provider_definition_request import TestLlmProviderDefinitionRequest + +# body param +SchemaForRequestBodyApplicationJson = TestLlmProviderDefinitionRequest + + +request_body_test_llm_provider_definition_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = TestLlmProviderResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _test_llm_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _test_llm_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _test_llm_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _test_llm_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _test_llm_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Test LLM Provider + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_test_llm_provider_definition_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class TestLlmProvider(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def test_llm_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def test_llm_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def test_llm_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def test_llm_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def test_llm_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._test_llm_provider_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._test_llm_provider_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_compute_column_statistics/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_compute_column_statistics/__init__.py new file mode 100644 index 000000000..ee34c4c53 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_compute_column_statistics/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_data_sources_data_source_id_compute_column_statistics import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_DATA_SOURCES_DATA_SOURCE_ID_COMPUTE_COLUMN_STATISTICS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_compute_column_statistics/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_compute_column_statistics/post.py new file mode 100644 index 000000000..b79718bd9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_compute_column_statistics/post.py @@ -0,0 +1,391 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.column_statistics_response import ColumnStatisticsResponse +from gooddata_api_client.model.column_statistics_request import ColumnStatisticsRequest + +from . import path + +# Path params +DataSourceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'dataSourceId': typing.Union[DataSourceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_data_source_id = api_client.PathParameter( + name="dataSourceId", + style=api_client.ParameterStyle.SIMPLE, + schema=DataSourceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ColumnStatisticsRequest + + +request_body_column_statistics_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ColumnStatisticsResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _column_statistics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _column_statistics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _column_statistics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _column_statistics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _column_statistics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Compute column statistics + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_data_source_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_column_statistics_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ColumnStatistics(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def column_statistics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def column_statistics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def column_statistics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def column_statistics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def column_statistics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._column_statistics_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._column_statistics_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_compute_column_statistics/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_compute_column_statistics/post.pyi new file mode 100644 index 000000000..c97d17622 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_compute_column_statistics/post.pyi @@ -0,0 +1,386 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.column_statistics_response import ColumnStatisticsResponse +from gooddata_api_client.model.column_statistics_request import ColumnStatisticsRequest + +# Path params +DataSourceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'dataSourceId': typing.Union[DataSourceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_data_source_id = api_client.PathParameter( + name="dataSourceId", + style=api_client.ParameterStyle.SIMPLE, + schema=DataSourceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ColumnStatisticsRequest + + +request_body_column_statistics_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ColumnStatisticsResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _column_statistics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _column_statistics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _column_statistics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _column_statistics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _column_statistics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Compute column statistics + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_data_source_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_column_statistics_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ColumnStatistics(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def column_statistics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def column_statistics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def column_statistics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def column_statistics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def column_statistics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._column_statistics_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._column_statistics_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model_aac/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model_aac/__init__.py new file mode 100644 index 000000000..b0e400e35 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model_aac/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_data_sources_data_source_id_generate_logical_model_aac import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_DATA_SOURCES_DATA_SOURCE_ID_GENERATE_LOGICAL_MODEL_AAC \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model_aac/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model_aac/post.py new file mode 100644 index 000000000..ef6a0612d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model_aac/post.py @@ -0,0 +1,391 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.model.aac_logical_model import AacLogicalModel + +from . import path + +# Path params +DataSourceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'dataSourceId': typing.Union[DataSourceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_data_source_id = api_client.PathParameter( + name="dataSourceId", + style=api_client.ParameterStyle.SIMPLE, + schema=DataSourceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = GenerateLdmRequest + + +request_body_generate_ldm_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = AacLogicalModel + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _generate_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _generate_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _generate_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _generate_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _generate_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Generate logical data model in AAC format from physical data model (PDM) + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_data_source_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_generate_ldm_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GenerateLogicalModelAac(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def generate_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def generate_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def generate_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def generate_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def generate_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._generate_logical_model_aac_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._generate_logical_model_aac_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model_aac/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model_aac/post.pyi new file mode 100644 index 000000000..93a7a7675 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_generate_logical_model_aac/post.pyi @@ -0,0 +1,386 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest +from gooddata_api_client.model.aac_logical_model import AacLogicalModel + +# Path params +DataSourceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'dataSourceId': typing.Union[DataSourceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_data_source_id = api_client.PathParameter( + name="dataSourceId", + style=api_client.ParameterStyle.SIMPLE, + schema=DataSourceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = GenerateLdmRequest + + +request_body_generate_ldm_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = AacLogicalModel + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _generate_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _generate_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _generate_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _generate_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _generate_logical_model_aac_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Generate logical data model in AAC format from physical data model (PDM) + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_data_source_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_generate_ldm_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GenerateLogicalModelAac(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def generate_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def generate_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def generate_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def generate_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def generate_logical_model_aac( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._generate_logical_model_aac_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._generate_logical_model_aac_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_manage_permissions/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_manage_permissions/__init__.py new file mode 100644 index 000000000..d56c71c50 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_manage_permissions/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_data_sources_data_source_id_manage_permissions import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_DATA_SOURCES_DATA_SOURCE_ID_MANAGE_PERMISSIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_manage_permissions/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_manage_permissions/post.py new file mode 100644 index 000000000..ab62c8e3b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_manage_permissions/post.py @@ -0,0 +1,385 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.data_source_permission_assignment import DataSourcePermissionAssignment + +from . import path + +# Path params +DataSourceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'dataSourceId': typing.Union[DataSourceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_data_source_id = api_client.PathParameter( + name="dataSourceId", + style=api_client.ParameterStyle.SIMPLE, + schema=DataSourceIdSchema, + required=True, +) +# body param + + +class SchemaForRequestBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DataSourcePermissionAssignment']: + return DataSourcePermissionAssignment + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DataSourcePermissionAssignment'], typing.List['DataSourcePermissionAssignment']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaForRequestBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DataSourcePermissionAssignment': + return super().__getitem__(i) + + +request_body_data_source_permission_assignment = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _manage_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _manage_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _manage_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _manage_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _manage_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Manage Permissions for a Data Source + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_data_source_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_data_source_permission_assignment.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ManageDataSourcePermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def manage_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def manage_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def manage_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def manage_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def manage_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_data_source_permissions_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_data_source_permissions_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_manage_permissions/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_manage_permissions/post.pyi new file mode 100644 index 000000000..b758d0792 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_data_sources_data_source_id_manage_permissions/post.pyi @@ -0,0 +1,380 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.data_source_permission_assignment import DataSourcePermissionAssignment + +# Path params +DataSourceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'dataSourceId': typing.Union[DataSourceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_data_source_id = api_client.PathParameter( + name="dataSourceId", + style=api_client.ParameterStyle.SIMPLE, + schema=DataSourceIdSchema, + required=True, +) +# body param + + +class SchemaForRequestBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DataSourcePermissionAssignment']: + return DataSourcePermissionAssignment + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DataSourcePermissionAssignment'], typing.List['DataSourcePermissionAssignment']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaForRequestBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DataSourcePermissionAssignment': + return super().__getitem__(i) + + +request_body_data_source_permission_assignment = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _manage_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _manage_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _manage_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _manage_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _manage_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Manage Permissions for a Data Source + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_data_source_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_data_source_permission_assignment.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ManageDataSourcePermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def manage_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def manage_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def manage_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def manage_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def manage_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_data_source_permissions_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_data_source_permissions_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_notification_channel_id_test/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_notification_channel_id_test/__init__.py new file mode 100644 index 000000000..69c7535a7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_notification_channel_id_test/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_notification_channels_notification_channel_id_test import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_NOTIFICATION_CHANNELS_NOTIFICATION_CHANNEL_ID_TEST \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_notification_channel_id_test/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_notification_channel_id_test/post.py new file mode 100644 index 000000000..b9c1ecd05 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_notification_channel_id_test/post.py @@ -0,0 +1,388 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.test_response import TestResponse +from gooddata_api_client.model.test_destination_request import TestDestinationRequest + +from . import path + +# Path params +NotificationChannelIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'notificationChannelId': typing.Union[NotificationChannelIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_notification_channel_id = api_client.PathParameter( + name="notificationChannelId", + style=api_client.ParameterStyle.SIMPLE, + schema=NotificationChannelIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = TestDestinationRequest + + +request_body_test_destination_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, +) +SchemaFor200ResponseBodyApplicationJson = TestResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _test_existing_notification_channel_oapg( + self, + content_type: typing_extensions.Literal["application/json"] = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _test_existing_notification_channel_oapg( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _test_existing_notification_channel_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _test_existing_notification_channel_oapg( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _test_existing_notification_channel_oapg( + self, + content_type: str = 'application/json', + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Test existing notification channel. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_notification_channel_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + _fields = None + _body = None + if body is not schemas.unset: + serialized_data = request_body_test_destination_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class TestExistingNotificationChannel(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def test_existing_notification_channel( + self, + content_type: typing_extensions.Literal["application/json"] = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def test_existing_notification_channel( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def test_existing_notification_channel( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def test_existing_notification_channel( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def test_existing_notification_channel( + self, + content_type: str = 'application/json', + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._test_existing_notification_channel_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + content_type: typing_extensions.Literal["application/json"] = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + content_type: str = 'application/json', + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._test_existing_notification_channel_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_notification_channel_id_test/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_notification_channel_id_test/post.pyi new file mode 100644 index 000000000..d509261e2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_notification_channel_id_test/post.pyi @@ -0,0 +1,383 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.test_response import TestResponse +from gooddata_api_client.model.test_destination_request import TestDestinationRequest + +# Path params +NotificationChannelIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'notificationChannelId': typing.Union[NotificationChannelIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_notification_channel_id = api_client.PathParameter( + name="notificationChannelId", + style=api_client.ParameterStyle.SIMPLE, + schema=NotificationChannelIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = TestDestinationRequest + + +request_body_test_destination_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, +) +SchemaFor200ResponseBodyApplicationJson = TestResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _test_existing_notification_channel_oapg( + self, + content_type: typing_extensions.Literal["application/json"] = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _test_existing_notification_channel_oapg( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _test_existing_notification_channel_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _test_existing_notification_channel_oapg( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _test_existing_notification_channel_oapg( + self, + content_type: str = 'application/json', + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Test existing notification channel. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_notification_channel_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + _fields = None + _body = None + if body is not schemas.unset: + serialized_data = request_body_test_destination_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class TestExistingNotificationChannel(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def test_existing_notification_channel( + self, + content_type: typing_extensions.Literal["application/json"] = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def test_existing_notification_channel( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def test_existing_notification_channel( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def test_existing_notification_channel( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def test_existing_notification_channel( + self, + content_type: str = 'application/json', + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._test_existing_notification_channel_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + content_type: typing_extensions.Literal["application/json"] = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + content_type: str = ..., + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + content_type: str = 'application/json', + body: typing.Union[SchemaForRequestBodyApplicationJson, schemas.Unset] = schemas.unset, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._test_existing_notification_channel_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_test/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_test/__init__.py new file mode 100644 index 000000000..9e7acdfc5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_test/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_notification_channels_test import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_NOTIFICATION_CHANNELS_TEST \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_test/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_test/post.py new file mode 100644 index 000000000..f19223a0e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_test/post.py @@ -0,0 +1,334 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.test_response import TestResponse +from gooddata_api_client.model.test_destination_request import TestDestinationRequest + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = TestDestinationRequest + + +request_body_test_destination_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = TestResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _test_notification_channel_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _test_notification_channel_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _test_notification_channel_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _test_notification_channel_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _test_notification_channel_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Test notification channel. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_test_destination_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class TestNotificationChannel(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def test_notification_channel( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def test_notification_channel( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def test_notification_channel( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def test_notification_channel( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def test_notification_channel( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._test_notification_channel_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._test_notification_channel_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_test/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_test/post.pyi new file mode 100644 index 000000000..0d80c3da2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notification_channels_test/post.pyi @@ -0,0 +1,329 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.test_response import TestResponse +from gooddata_api_client.model.test_destination_request import TestDestinationRequest + +# body param +SchemaForRequestBodyApplicationJson = TestDestinationRequest + + +request_body_test_destination_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = TestResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _test_notification_channel_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _test_notification_channel_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _test_notification_channel_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _test_notification_channel_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _test_notification_channel_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Test notification channel. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_test_destination_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class TestNotificationChannel(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def test_notification_channel( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def test_notification_channel( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def test_notification_channel( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def test_notification_channel( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def test_notification_channel( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._test_notification_channel_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._test_notification_channel_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications/__init__.py new file mode 100644 index 000000000..a5a019369 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_notifications import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_NOTIFICATIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications/get.py new file mode 100644 index 000000000..4db0f9ad4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications/get.py @@ -0,0 +1,386 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.notifications import Notifications + +from . import path + +# Query params +WorkspaceIdSchema = schemas.StrSchema +IsReadSchema = schemas.BoolSchema + + +class PageSchema( + schemas.StrSchema +): + + + class MetaOapg: + + +class SizeSchema( + schemas.StrSchema +): + + + class MetaOapg: + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "total": "TOTAL", + "ALL": "ALL", + } + + @schemas.classproperty + def TOTAL(cls): + return cls("total") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'isRead': typing.Union[IsReadSchema, bool, ], + 'page': typing.Union[PageSchema, str, ], + 'size': typing.Union[SizeSchema, str, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_workspace_id = api_client.QueryParameter( + name="workspaceId", + style=api_client.ParameterStyle.FORM, + schema=WorkspaceIdSchema, + explode=True, +) +request_query_is_read = api_client.QueryParameter( + name="isRead", + style=api_client.ParameterStyle.FORM, + schema=IsReadSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, + explode=True, +) +SchemaFor200ResponseBodyApplicationJson = Notifications + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_notifications_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_notifications_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_notifications_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_notifications_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get latest notifications. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_workspace_id, + request_query_is_read, + request_query_page, + request_query_size, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetNotifications(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_notifications( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_notifications( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_notifications( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_notifications( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_notifications_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_notifications_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications/get.pyi new file mode 100644 index 000000000..a3379d62a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications/get.pyi @@ -0,0 +1,369 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.notifications import Notifications + +# Query params +WorkspaceIdSchema = schemas.StrSchema +IsReadSchema = schemas.BoolSchema + + +class PageSchema( + schemas.StrSchema +): + pass + + +class SizeSchema( + schemas.StrSchema +): + pass + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def TOTAL(cls): + return cls("total") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'isRead': typing.Union[IsReadSchema, bool, ], + 'page': typing.Union[PageSchema, str, ], + 'size': typing.Union[SizeSchema, str, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_workspace_id = api_client.QueryParameter( + name="workspaceId", + style=api_client.ParameterStyle.FORM, + schema=WorkspaceIdSchema, + explode=True, +) +request_query_is_read = api_client.QueryParameter( + name="isRead", + style=api_client.ParameterStyle.FORM, + schema=IsReadSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, + explode=True, +) +SchemaFor200ResponseBodyApplicationJson = Notifications + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_notifications_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_notifications_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_notifications_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_notifications_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get latest notifications. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_workspace_id, + request_query_is_read, + request_query_page, + request_query_size, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetNotifications(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_notifications( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_notifications( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_notifications( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_notifications( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_notifications_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_notifications_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_mark_as_read/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_mark_as_read/__init__.py new file mode 100644 index 000000000..72128e8f9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_mark_as_read/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_notifications_mark_as_read import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_NOTIFICATIONS_MARK_AS_READ \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_mark_as_read/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_mark_as_read/post.py new file mode 100644 index 000000000..3f0ced9a7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_mark_as_read/post.py @@ -0,0 +1,260 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Query params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_workspace_id = api_client.QueryParameter( + name="workspaceId", + style=api_client.ParameterStyle.FORM, + schema=WorkspaceIdSchema, + explode=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _mark_as_read_notification_all_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _mark_as_read_notification_all_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _mark_as_read_notification_all_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _mark_as_read_notification_all_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Mark all notifications as read. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_workspace_id, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class MarkAsReadNotificationAll(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def mark_as_read_notification_all( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def mark_as_read_notification_all( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def mark_as_read_notification_all( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def mark_as_read_notification_all( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._mark_as_read_notification_all_oapg( + query_params=query_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._mark_as_read_notification_all_oapg( + query_params=query_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_mark_as_read/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_mark_as_read/post.pyi new file mode 100644 index 000000000..9a25f8bc7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_mark_as_read/post.pyi @@ -0,0 +1,255 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Query params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_workspace_id = api_client.QueryParameter( + name="workspaceId", + style=api_client.ParameterStyle.FORM, + schema=WorkspaceIdSchema, + explode=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _mark_as_read_notification_all_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _mark_as_read_notification_all_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _mark_as_read_notification_all_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _mark_as_read_notification_all_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Mark all notifications as read. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_workspace_id, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class MarkAsReadNotificationAll(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def mark_as_read_notification_all( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def mark_as_read_notification_all( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def mark_as_read_notification_all( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def mark_as_read_notification_all( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._mark_as_read_notification_all_oapg( + query_params=query_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._mark_as_read_notification_all_oapg( + query_params=query_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_notification_id_mark_as_read/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_notification_id_mark_as_read/__init__.py new file mode 100644 index 000000000..81cac41b0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_notification_id_mark_as_read/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_notifications_notification_id_mark_as_read import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_NOTIFICATIONS_NOTIFICATION_ID_MARK_AS_READ \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_notification_id_mark_as_read/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_notification_id_mark_as_read/post.py new file mode 100644 index 000000000..26c7a06cc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_notification_id_mark_as_read/post.py @@ -0,0 +1,260 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Path params +NotificationIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'notificationId': typing.Union[NotificationIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_notification_id = api_client.PathParameter( + name="notificationId", + style=api_client.ParameterStyle.SIMPLE, + schema=NotificationIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _mark_as_read_notification_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _mark_as_read_notification_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _mark_as_read_notification_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _mark_as_read_notification_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Mark notification as read. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_notification_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class MarkAsReadNotification(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def mark_as_read_notification( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def mark_as_read_notification( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def mark_as_read_notification( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def mark_as_read_notification( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._mark_as_read_notification_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._mark_as_read_notification_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_notification_id_mark_as_read/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_notification_id_mark_as_read/post.pyi new file mode 100644 index 000000000..1d15fab9d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_notifications_notification_id_mark_as_read/post.pyi @@ -0,0 +1,255 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Path params +NotificationIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'notificationId': typing.Union[NotificationIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_notification_id = api_client.PathParameter( + name="notificationId", + style=api_client.ParameterStyle.SIMPLE, + schema=NotificationIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _mark_as_read_notification_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _mark_as_read_notification_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _mark_as_read_notification_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _mark_as_read_notification_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Mark notification as read. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_notification_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class MarkAsReadNotification(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def mark_as_read_notification( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def mark_as_read_notification( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def mark_as_read_notification( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def mark_as_read_notification( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._mark_as_read_notification_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._mark_as_read_notification_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_delete/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_delete/__init__.py new file mode 100644 index 000000000..a129c45e3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_delete/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_organization_automations_delete import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_ORGANIZATION_AUTOMATIONS_DELETE \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_delete/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_delete/post.py new file mode 100644 index 000000000..36bc077a0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_delete/post.py @@ -0,0 +1,303 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = OrganizationAutomationManagementBulkRequest + + +request_body_organization_automation_management_bulk_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _delete_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete selected automations across all workspaces + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_organization_automation_management_bulk_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteOrganizationAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def delete_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_organization_automations_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_organization_automations_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_delete/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_delete/post.pyi new file mode 100644 index 000000000..8a9435bc2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_delete/post.pyi @@ -0,0 +1,298 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest + +# body param +SchemaForRequestBodyApplicationJson = OrganizationAutomationManagementBulkRequest + + +request_body_organization_automation_management_bulk_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _delete_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete selected automations across all workspaces + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_organization_automation_management_bulk_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteOrganizationAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def delete_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_organization_automations_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_organization_automations_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_pause/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_pause/__init__.py new file mode 100644 index 000000000..23e1e26a5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_pause/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_organization_automations_pause import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_ORGANIZATION_AUTOMATIONS_PAUSE \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_pause/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_pause/post.py new file mode 100644 index 000000000..936d204f8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_pause/post.py @@ -0,0 +1,303 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = OrganizationAutomationManagementBulkRequest + + +request_body_organization_automation_management_bulk_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _pause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _pause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _pause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _pause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _pause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Pause selected automations across all workspaces + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_organization_automation_management_bulk_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PauseOrganizationAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def pause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def pause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def pause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def pause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def pause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._pause_organization_automations_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._pause_organization_automations_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_pause/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_pause/post.pyi new file mode 100644 index 000000000..402829e00 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_pause/post.pyi @@ -0,0 +1,298 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest + +# body param +SchemaForRequestBodyApplicationJson = OrganizationAutomationManagementBulkRequest + + +request_body_organization_automation_management_bulk_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _pause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _pause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _pause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _pause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _pause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Pause selected automations across all workspaces + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_organization_automation_management_bulk_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PauseOrganizationAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def pause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def pause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def pause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def pause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def pause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._pause_organization_automations_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._pause_organization_automations_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unpause/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unpause/__init__.py new file mode 100644 index 000000000..bb76f326e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unpause/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_organization_automations_unpause import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_ORGANIZATION_AUTOMATIONS_UNPAUSE \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unpause/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unpause/post.py new file mode 100644 index 000000000..084f6ded8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unpause/post.py @@ -0,0 +1,303 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = OrganizationAutomationManagementBulkRequest + + +request_body_organization_automation_management_bulk_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _unpause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _unpause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _unpause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _unpause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _unpause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Unpause selected automations across all workspaces + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_organization_automation_management_bulk_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UnpauseOrganizationAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def unpause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def unpause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def unpause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def unpause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def unpause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unpause_organization_automations_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unpause_organization_automations_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unpause/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unpause/post.pyi new file mode 100644 index 000000000..b0607785b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unpause/post.pyi @@ -0,0 +1,298 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest + +# body param +SchemaForRequestBodyApplicationJson = OrganizationAutomationManagementBulkRequest + + +request_body_organization_automation_management_bulk_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _unpause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _unpause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _unpause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _unpause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _unpause_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Unpause selected automations across all workspaces + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_organization_automation_management_bulk_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UnpauseOrganizationAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def unpause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def unpause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def unpause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def unpause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def unpause_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unpause_organization_automations_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unpause_organization_automations_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unsubscribe/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unsubscribe/__init__.py new file mode 100644 index 000000000..ca8d1a450 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unsubscribe/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_organization_automations_unsubscribe import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_ORGANIZATION_AUTOMATIONS_UNSUBSCRIBE \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unsubscribe/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unsubscribe/delete.py new file mode 100644 index 000000000..8b4be35c9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unsubscribe/delete.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _unsubscribe_all_automations_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _unsubscribe_all_automations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _unsubscribe_all_automations_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _unsubscribe_all_automations_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Unsubscribe from all automations in all workspaces + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UnsubscribeAllAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def unsubscribe_all_automations( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def unsubscribe_all_automations( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def unsubscribe_all_automations( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def unsubscribe_all_automations( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_all_automations_oapg( + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_all_automations_oapg( + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unsubscribe/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unsubscribe/delete.pyi new file mode 100644 index 000000000..6f1019f2c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unsubscribe/delete.pyi @@ -0,0 +1,201 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _unsubscribe_all_automations_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _unsubscribe_all_automations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _unsubscribe_all_automations_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _unsubscribe_all_automations_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Unsubscribe from all automations in all workspaces + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UnsubscribeAllAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def unsubscribe_all_automations( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def unsubscribe_all_automations( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def unsubscribe_all_automations( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def unsubscribe_all_automations( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_all_automations_oapg( + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_all_automations_oapg( + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unsubscribe/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unsubscribe/post.py new file mode 100644 index 000000000..d34014222 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unsubscribe/post.py @@ -0,0 +1,303 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = OrganizationAutomationManagementBulkRequest + + +request_body_organization_automation_management_bulk_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _unsubscribe_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _unsubscribe_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _unsubscribe_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _unsubscribe_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _unsubscribe_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Unsubscribe from selected automations across all workspaces + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_organization_automation_management_bulk_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UnsubscribeOrganizationAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def unsubscribe_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def unsubscribe_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def unsubscribe_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def unsubscribe_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def unsubscribe_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_organization_automations_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_organization_automations_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unsubscribe/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unsubscribe/post.pyi new file mode 100644 index 000000000..571931866 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_automations_unsubscribe/post.pyi @@ -0,0 +1,298 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest + +# body param +SchemaForRequestBodyApplicationJson = OrganizationAutomationManagementBulkRequest + + +request_body_organization_automation_management_bulk_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _unsubscribe_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _unsubscribe_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _unsubscribe_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _unsubscribe_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _unsubscribe_organization_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Unsubscribe from selected automations across all workspaces + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_organization_automation_management_bulk_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UnsubscribeOrganizationAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def unsubscribe_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def unsubscribe_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def unsubscribe_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def unsubscribe_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def unsubscribe_organization_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_organization_automations_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_organization_automations_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_manage_permissions/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_manage_permissions/__init__.py new file mode 100644 index 000000000..629d466b3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_manage_permissions/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_organization_manage_permissions import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_ORGANIZATION_MANAGE_PERMISSIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_manage_permissions/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_manage_permissions/post.py new file mode 100644 index 000000000..ec6432903 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_manage_permissions/post.py @@ -0,0 +1,328 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.organization_permission_assignment import OrganizationPermissionAssignment + +from . import path + +# body param + + +class SchemaForRequestBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['OrganizationPermissionAssignment']: + return OrganizationPermissionAssignment + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['OrganizationPermissionAssignment'], typing.List['OrganizationPermissionAssignment']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaForRequestBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'OrganizationPermissionAssignment': + return super().__getitem__(i) + + +request_body_organization_permission_assignment = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _manage_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _manage_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _manage_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _manage_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _manage_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Manage Permissions for a Organization + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_organization_permission_assignment.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ManageOrganizationPermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def manage_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def manage_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def manage_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def manage_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def manage_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_organization_permissions_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_organization_permissions_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_manage_permissions/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_manage_permissions/post.pyi new file mode 100644 index 000000000..89aabe4cd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_manage_permissions/post.pyi @@ -0,0 +1,323 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.organization_permission_assignment import OrganizationPermissionAssignment + +# body param + + +class SchemaForRequestBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['OrganizationPermissionAssignment']: + return OrganizationPermissionAssignment + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['OrganizationPermissionAssignment'], typing.List['OrganizationPermissionAssignment']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaForRequestBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'OrganizationPermissionAssignment': + return super().__getitem__(i) + + +request_body_organization_permission_assignment = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _manage_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _manage_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _manage_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _manage_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _manage_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Manage Permissions for a Organization + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_organization_permission_assignment.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ManageOrganizationPermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def manage_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def manage_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def manage_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def manage_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def manage_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_organization_permissions_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_organization_permissions_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_check/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_check/__init__.py new file mode 100644 index 000000000..b341b5c8a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_check/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_organization_metadata_check import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_ORGANIZATION_METADATA_CHECK \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_check/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_check/post.py new file mode 100644 index 000000000..c2ad435d8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_check/post.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, +) +_status_code_to_response = { + '200': _response_for_200, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _metadata_check_organization_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _metadata_check_organization_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _metadata_check_organization_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _metadata_check_organization_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Check Organization Metadata Inconsistencies + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class MetadataCheckOrganization(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def metadata_check_organization( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def metadata_check_organization( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def metadata_check_organization( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def metadata_check_organization( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._metadata_check_organization_oapg( + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._metadata_check_organization_oapg( + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_check/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_check/post.pyi new file mode 100644 index 000000000..561bcd571 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_check/post.pyi @@ -0,0 +1,201 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _metadata_check_organization_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _metadata_check_organization_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _metadata_check_organization_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _metadata_check_organization_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Check Organization Metadata Inconsistencies + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class MetadataCheckOrganization(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def metadata_check_organization( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def metadata_check_organization( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def metadata_check_organization( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def metadata_check_organization( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._metadata_check_organization_oapg( + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._metadata_check_organization_oapg( + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_sync/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_sync/__init__.py new file mode 100644 index 000000000..a6d8e183b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_sync/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_organization_metadata_sync import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_ORGANIZATION_METADATA_SYNC \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_sync/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_sync/post.py new file mode 100644 index 000000000..c8a4404cd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_sync/post.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, +) +_status_code_to_response = { + '200': _response_for_200, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _metadata_sync_organization_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _metadata_sync_organization_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _metadata_sync_organization_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _metadata_sync_organization_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Sync organization scope Metadata to other services + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class MetadataSyncOrganization(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def metadata_sync_organization( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def metadata_sync_organization( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def metadata_sync_organization( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def metadata_sync_organization( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._metadata_sync_organization_oapg( + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._metadata_sync_organization_oapg( + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_sync/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_sync/post.pyi new file mode 100644 index 000000000..6dcd49f27 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_metadata_sync/post.pyi @@ -0,0 +1,201 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _metadata_sync_organization_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _metadata_sync_organization_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _metadata_sync_organization_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _metadata_sync_organization_oapg( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Sync organization scope Metadata to other services + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class MetadataSyncOrganization(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def metadata_sync_organization( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def metadata_sync_organization( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def metadata_sync_organization( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def metadata_sync_organization( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._metadata_sync_organization_oapg( + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._metadata_sync_organization_oapg( + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_switch_active_identity_provider/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_switch_active_identity_provider/__init__.py new file mode 100644 index 000000000..6cc147ef3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_switch_active_identity_provider/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_organization_switch_active_identity_provider import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_ORGANIZATION_SWITCH_ACTIVE_IDENTITY_PROVIDER \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_switch_active_identity_provider/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_switch_active_identity_provider/post.py new file mode 100644 index 000000000..1010e67c8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_switch_active_identity_provider/post.py @@ -0,0 +1,303 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.switch_identity_provider_request import SwitchIdentityProviderRequest + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = SwitchIdentityProviderRequest + + +request_body_switch_identity_provider_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _switch_active_identity_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _switch_active_identity_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _switch_active_identity_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _switch_active_identity_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _switch_active_identity_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Switch Active Identity Provider + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_switch_identity_provider_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SwitchActiveIdentityProvider(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def switch_active_identity_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def switch_active_identity_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def switch_active_identity_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def switch_active_identity_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def switch_active_identity_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._switch_active_identity_provider_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._switch_active_identity_provider_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_switch_active_identity_provider/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_switch_active_identity_provider/post.pyi new file mode 100644 index 000000000..d5e791ff8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_organization_switch_active_identity_provider/post.pyi @@ -0,0 +1,298 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.switch_identity_provider_request import SwitchIdentityProviderRequest + +# body param +SchemaForRequestBodyApplicationJson = SwitchIdentityProviderRequest + + +request_body_switch_identity_provider_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _switch_active_identity_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _switch_active_identity_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _switch_active_identity_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _switch_active_identity_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _switch_active_identity_provider_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Switch Active Identity Provider + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_switch_identity_provider_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SwitchActiveIdentityProvider(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def switch_active_identity_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def switch_active_identity_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def switch_active_identity_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def switch_active_identity_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def switch_active_identity_provider( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._switch_active_identity_provider_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._switch_active_identity_provider_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_assign_permissions/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_assign_permissions/__init__.py new file mode 100644 index 000000000..b4d0dcbe7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_assign_permissions/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_user_management_assign_permissions import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_USER_MANAGEMENT_ASSIGN_PERMISSIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_assign_permissions/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_assign_permissions/post.py new file mode 100644 index 000000000..0b795a11a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_assign_permissions/post.py @@ -0,0 +1,302 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.permissions_assignment import PermissionsAssignment + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = PermissionsAssignment + + +request_body_permissions_assignment = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, +) +_status_code_to_response = { + '200': _response_for_200, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _assign_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _assign_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _assign_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _assign_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _assign_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_permissions_assignment.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AssignPermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def assign_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def assign_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def assign_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def assign_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def assign_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._assign_permissions_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._assign_permissions_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_assign_permissions/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_assign_permissions/post.pyi new file mode 100644 index 000000000..fc4770338 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_assign_permissions/post.pyi @@ -0,0 +1,297 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.permissions_assignment import PermissionsAssignment + +# body param +SchemaForRequestBodyApplicationJson = PermissionsAssignment + + +request_body_permissions_assignment = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _assign_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _assign_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _assign_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _assign_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _assign_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_permissions_assignment.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AssignPermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def assign_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def assign_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def assign_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def assign_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def assign_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._assign_permissions_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._assign_permissions_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_remove_users_user_groups/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_remove_users_user_groups/__init__.py new file mode 100644 index 000000000..b934c8d56 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_remove_users_user_groups/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_user_management_remove_users_user_groups import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_USER_MANAGEMENT_REMOVE_USERS_USER_GROUPS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_remove_users_user_groups/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_remove_users_user_groups/post.py new file mode 100644 index 000000000..1edb89843 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_remove_users_user_groups/post.py @@ -0,0 +1,327 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier + +from . import path + +# body param + + +class SchemaForRequestBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AssigneeIdentifier']: + return AssigneeIdentifier + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AssigneeIdentifier'], typing.List['AssigneeIdentifier']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaForRequestBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AssigneeIdentifier': + return super().__getitem__(i) + + +request_body_assignee_identifier = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, +) +_status_code_to_response = { + '200': _response_for_200, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _remove_users_user_groups_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _remove_users_user_groups_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _remove_users_user_groups_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _remove_users_user_groups_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _remove_users_user_groups_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_assignee_identifier.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class RemoveUsersUserGroups(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def remove_users_user_groups( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def remove_users_user_groups( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def remove_users_user_groups( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def remove_users_user_groups( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def remove_users_user_groups( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._remove_users_user_groups_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._remove_users_user_groups_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_remove_users_user_groups/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_remove_users_user_groups/post.pyi new file mode 100644 index 000000000..06bdc0bc3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_remove_users_user_groups/post.pyi @@ -0,0 +1,322 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier + +# body param + + +class SchemaForRequestBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['AssigneeIdentifier']: + return AssigneeIdentifier + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['AssigneeIdentifier'], typing.List['AssigneeIdentifier']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaForRequestBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'AssigneeIdentifier': + return super().__getitem__(i) + + +request_body_assignee_identifier = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _remove_users_user_groups_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _remove_users_user_groups_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _remove_users_user_groups_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _remove_users_user_groups_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _remove_users_user_groups_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_assignee_identifier.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class RemoveUsersUserGroups(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def remove_users_user_groups( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def remove_users_user_groups( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def remove_users_user_groups( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def remove_users_user_groups( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def remove_users_user_groups( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._remove_users_user_groups_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._remove_users_user_groups_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_revoke_permissions/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_revoke_permissions/__init__.py new file mode 100644 index 000000000..0a69165ab --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_revoke_permissions/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_user_management_revoke_permissions import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_USER_MANAGEMENT_REVOKE_PERMISSIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_revoke_permissions/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_revoke_permissions/post.py new file mode 100644 index 000000000..e2198111b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_revoke_permissions/post.py @@ -0,0 +1,302 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.permissions_assignment import PermissionsAssignment + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = PermissionsAssignment + + +request_body_permissions_assignment = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, +) +_status_code_to_response = { + '200': _response_for_200, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _revoke_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _revoke_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _revoke_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _revoke_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _revoke_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_permissions_assignment.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class RevokePermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def revoke_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def revoke_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def revoke_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def revoke_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def revoke_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._revoke_permissions_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._revoke_permissions_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_revoke_permissions/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_revoke_permissions/post.pyi new file mode 100644 index 000000000..3cc92f29e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_revoke_permissions/post.pyi @@ -0,0 +1,297 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.permissions_assignment import PermissionsAssignment + +# body param +SchemaForRequestBodyApplicationJson = PermissionsAssignment + + +request_body_permissions_assignment = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _revoke_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _revoke_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _revoke_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _revoke_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _revoke_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_permissions_assignment.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class RevokePermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def revoke_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def revoke_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def revoke_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def revoke_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def revoke_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._revoke_permissions_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._revoke_permissions_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups/__init__.py new file mode 100644 index 000000000..d06372031 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_user_management_user_groups import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_USER_MANAGEMENT_USER_GROUPS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups/get.py new file mode 100644 index 000000000..111ee72be --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups/get.py @@ -0,0 +1,328 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_user_groups import UserManagementUserGroups + +from . import path + +# Query params +PageSchema = schemas.Int32Schema +SizeSchema = schemas.Int32Schema +NameSchema = schemas.StrSchema +WorkspaceSchema = schemas.StrSchema +DataSourceSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'name': typing.Union[NameSchema, str, ], + 'workspace': typing.Union[WorkspaceSchema, str, ], + 'dataSource': typing.Union[DataSourceSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_name = api_client.QueryParameter( + name="name", + style=api_client.ParameterStyle.FORM, + schema=NameSchema, + explode=True, +) +request_query_workspace = api_client.QueryParameter( + name="workspace", + style=api_client.ParameterStyle.FORM, + schema=WorkspaceSchema, + explode=True, +) +request_query_data_source = api_client.QueryParameter( + name="dataSource", + style=api_client.ParameterStyle.FORM, + schema=DataSourceSchema, + explode=True, +) +SchemaFor200ResponseBodyApplicationJson = UserManagementUserGroups + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_user_groups_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_user_groups_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_user_groups_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_user_groups_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_page, + request_query_size, + request_query_name, + request_query_workspace, + request_query_data_source, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListUserGroups(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_user_groups( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_user_groups( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_user_groups( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_user_groups( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_user_groups_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_user_groups_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups/get.pyi new file mode 100644 index 000000000..f6e694cdc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups/get.pyi @@ -0,0 +1,323 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_user_groups import UserManagementUserGroups + +# Query params +PageSchema = schemas.Int32Schema +SizeSchema = schemas.Int32Schema +NameSchema = schemas.StrSchema +WorkspaceSchema = schemas.StrSchema +DataSourceSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'name': typing.Union[NameSchema, str, ], + 'workspace': typing.Union[WorkspaceSchema, str, ], + 'dataSource': typing.Union[DataSourceSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_name = api_client.QueryParameter( + name="name", + style=api_client.ParameterStyle.FORM, + schema=NameSchema, + explode=True, +) +request_query_workspace = api_client.QueryParameter( + name="workspace", + style=api_client.ParameterStyle.FORM, + schema=WorkspaceSchema, + explode=True, +) +request_query_data_source = api_client.QueryParameter( + name="dataSource", + style=api_client.ParameterStyle.FORM, + schema=DataSourceSchema, + explode=True, +) +SchemaFor200ResponseBodyApplicationJson = UserManagementUserGroups + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_user_groups_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_user_groups_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_user_groups_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_user_groups_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_page, + request_query_size, + request_query_name, + request_query_workspace, + request_query_data_source, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListUserGroups(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_user_groups( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_user_groups( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_user_groups( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_user_groups( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_user_groups_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_user_groups_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_add_members/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_add_members/__init__.py new file mode 100644 index 000000000..2c4562eb4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_add_members/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_user_management_user_groups_user_group_id_add_members import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_USER_MANAGEMENT_USER_GROUPS_USER_GROUP_ID_ADD_MEMBERS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_add_members/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_add_members/post.py new file mode 100644 index 000000000..a745d0bc8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_add_members/post.py @@ -0,0 +1,359 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_user_group_members import UserManagementUserGroupMembers + +from . import path + +# Path params +UserGroupIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'userGroupId': typing.Union[UserGroupIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_user_group_id = api_client.PathParameter( + name="userGroupId", + style=api_client.ParameterStyle.SIMPLE, + schema=UserGroupIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = UserManagementUserGroupMembers + + +request_body_user_management_user_group_members = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _add_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _add_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _add_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _add_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _add_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_user_group_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_user_management_user_group_members.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AddGroupMembers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def add_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def add_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def add_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def add_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def add_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._add_group_members_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._add_group_members_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_add_members/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_add_members/post.pyi new file mode 100644 index 000000000..c341ed13c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_add_members/post.pyi @@ -0,0 +1,354 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_user_group_members import UserManagementUserGroupMembers + +# Path params +UserGroupIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'userGroupId': typing.Union[UserGroupIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_user_group_id = api_client.PathParameter( + name="userGroupId", + style=api_client.ParameterStyle.SIMPLE, + schema=UserGroupIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = UserManagementUserGroupMembers + + +request_body_user_management_user_group_members = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _add_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _add_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _add_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _add_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _add_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_user_group_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_user_management_user_group_members.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AddGroupMembers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def add_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def add_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def add_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def add_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def add_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._add_group_members_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._add_group_members_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_members/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_members/__init__.py new file mode 100644 index 000000000..cfd4ac148 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_members/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_user_management_user_groups_user_group_id_members import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_USER_MANAGEMENT_USER_GROUPS_USER_GROUP_ID_MEMBERS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_members/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_members/get.py new file mode 100644 index 000000000..3bde419c2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_members/get.py @@ -0,0 +1,292 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_user_group_members import UserManagementUserGroupMembers + +from . import path + +# Path params +UserGroupIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'userGroupId': typing.Union[UserGroupIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_user_group_id = api_client.PathParameter( + name="userGroupId", + style=api_client.ParameterStyle.SIMPLE, + schema=UserGroupIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = UserManagementUserGroupMembers + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_group_members_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_group_members_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_group_members_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_group_members_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_user_group_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetGroupMembers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_group_members( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_group_members( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_group_members( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_group_members( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_group_members_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_group_members_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_members/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_members/get.pyi new file mode 100644 index 000000000..a70aeca79 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_members/get.pyi @@ -0,0 +1,287 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_user_group_members import UserManagementUserGroupMembers + +# Path params +UserGroupIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'userGroupId': typing.Union[UserGroupIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_user_group_id = api_client.PathParameter( + name="userGroupId", + style=api_client.ParameterStyle.SIMPLE, + schema=UserGroupIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = UserManagementUserGroupMembers + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_group_members_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_group_members_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_group_members_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_group_members_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_user_group_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetGroupMembers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_group_members( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_group_members( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_group_members( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_group_members( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_group_members_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_group_members_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions/__init__.py new file mode 100644 index 000000000..2c82a7ed6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_user_management_user_groups_user_group_id_permissions import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_USER_MANAGEMENT_USER_GROUPS_USER_GROUP_ID_PERMISSIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions/get.py new file mode 100644 index 000000000..927758ab4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions/get.py @@ -0,0 +1,292 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments + +from . import path + +# Path params +UserGroupIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'userGroupId': typing.Union[UserGroupIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_user_group_id = api_client.PathParameter( + name="userGroupId", + style=api_client.ParameterStyle.SIMPLE, + schema=UserGroupIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = UserManagementPermissionAssignments + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_permissions_for_user_group_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_permissions_for_user_group_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_permissions_for_user_group_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_permissions_for_user_group_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_user_group_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListPermissionsForUserGroup(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_permissions_for_user_group( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_permissions_for_user_group( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_permissions_for_user_group( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_permissions_for_user_group( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_permissions_for_user_group_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_permissions_for_user_group_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions/get.pyi new file mode 100644 index 000000000..b32592c52 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions/get.pyi @@ -0,0 +1,287 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments + +# Path params +UserGroupIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'userGroupId': typing.Union[UserGroupIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_user_group_id = api_client.PathParameter( + name="userGroupId", + style=api_client.ParameterStyle.SIMPLE, + schema=UserGroupIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = UserManagementPermissionAssignments + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_permissions_for_user_group_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_permissions_for_user_group_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_permissions_for_user_group_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_permissions_for_user_group_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_user_group_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListPermissionsForUserGroup(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_permissions_for_user_group( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_permissions_for_user_group( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_permissions_for_user_group( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_permissions_for_user_group( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_permissions_for_user_group_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_permissions_for_user_group_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions/post.py new file mode 100644 index 000000000..7b5d6ba0f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions/post.py @@ -0,0 +1,359 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments + +from . import path + +# Path params +UserGroupIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'userGroupId': typing.Union[UserGroupIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_user_group_id = api_client.PathParameter( + name="userGroupId", + style=api_client.ParameterStyle.SIMPLE, + schema=UserGroupIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = UserManagementPermissionAssignments + + +request_body_user_management_permission_assignments = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _manage_permissions_for_user_group_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _manage_permissions_for_user_group_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _manage_permissions_for_user_group_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _manage_permissions_for_user_group_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _manage_permissions_for_user_group_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_user_group_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_user_management_permission_assignments.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ManagePermissionsForUserGroup(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def manage_permissions_for_user_group( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def manage_permissions_for_user_group( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def manage_permissions_for_user_group( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def manage_permissions_for_user_group( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def manage_permissions_for_user_group( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_permissions_for_user_group_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_permissions_for_user_group_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions/post.pyi new file mode 100644 index 000000000..32ca7fbac --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_permissions/post.pyi @@ -0,0 +1,354 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments + +# Path params +UserGroupIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'userGroupId': typing.Union[UserGroupIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_user_group_id = api_client.PathParameter( + name="userGroupId", + style=api_client.ParameterStyle.SIMPLE, + schema=UserGroupIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = UserManagementPermissionAssignments + + +request_body_user_management_permission_assignments = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _manage_permissions_for_user_group_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _manage_permissions_for_user_group_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _manage_permissions_for_user_group_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _manage_permissions_for_user_group_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _manage_permissions_for_user_group_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_user_group_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_user_management_permission_assignments.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ManagePermissionsForUserGroup(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def manage_permissions_for_user_group( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def manage_permissions_for_user_group( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def manage_permissions_for_user_group( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def manage_permissions_for_user_group( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def manage_permissions_for_user_group( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_permissions_for_user_group_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_permissions_for_user_group_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_remove_members/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_remove_members/__init__.py new file mode 100644 index 000000000..be5fabe77 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_remove_members/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_user_management_user_groups_user_group_id_remove_members import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_USER_MANAGEMENT_USER_GROUPS_USER_GROUP_ID_REMOVE_MEMBERS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_remove_members/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_remove_members/post.py new file mode 100644 index 000000000..f38ba74f7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_remove_members/post.py @@ -0,0 +1,359 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_user_group_members import UserManagementUserGroupMembers + +from . import path + +# Path params +UserGroupIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'userGroupId': typing.Union[UserGroupIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_user_group_id = api_client.PathParameter( + name="userGroupId", + style=api_client.ParameterStyle.SIMPLE, + schema=UserGroupIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = UserManagementUserGroupMembers + + +request_body_user_management_user_group_members = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _remove_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _remove_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _remove_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _remove_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _remove_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_user_group_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_user_management_user_group_members.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class RemoveGroupMembers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def remove_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def remove_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def remove_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def remove_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def remove_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._remove_group_members_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._remove_group_members_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_remove_members/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_remove_members/post.pyi new file mode 100644 index 000000000..adc297295 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_user_groups_user_group_id_remove_members/post.pyi @@ -0,0 +1,354 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_user_group_members import UserManagementUserGroupMembers + +# Path params +UserGroupIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'userGroupId': typing.Union[UserGroupIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_user_group_id = api_client.PathParameter( + name="userGroupId", + style=api_client.ParameterStyle.SIMPLE, + schema=UserGroupIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = UserManagementUserGroupMembers + + +request_body_user_management_user_group_members = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _remove_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _remove_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _remove_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _remove_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _remove_group_members_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_user_group_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_user_management_user_group_members.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class RemoveGroupMembers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def remove_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def remove_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def remove_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def remove_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def remove_group_members( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._remove_group_members_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._remove_group_members_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users/__init__.py new file mode 100644 index 000000000..c874929f7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_user_management_users import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_USER_MANAGEMENT_USERS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users/get.py new file mode 100644 index 000000000..64b598682 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users/get.py @@ -0,0 +1,337 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_users import UserManagementUsers + +from . import path + +# Query params +PageSchema = schemas.Int32Schema +SizeSchema = schemas.Int32Schema +NameSchema = schemas.StrSchema +WorkspaceSchema = schemas.StrSchema +GroupSchema = schemas.StrSchema +DataSourceSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'name': typing.Union[NameSchema, str, ], + 'workspace': typing.Union[WorkspaceSchema, str, ], + 'group': typing.Union[GroupSchema, str, ], + 'dataSource': typing.Union[DataSourceSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_name = api_client.QueryParameter( + name="name", + style=api_client.ParameterStyle.FORM, + schema=NameSchema, + explode=True, +) +request_query_workspace = api_client.QueryParameter( + name="workspace", + style=api_client.ParameterStyle.FORM, + schema=WorkspaceSchema, + explode=True, +) +request_query_group = api_client.QueryParameter( + name="group", + style=api_client.ParameterStyle.FORM, + schema=GroupSchema, + explode=True, +) +request_query_data_source = api_client.QueryParameter( + name="dataSource", + style=api_client.ParameterStyle.FORM, + schema=DataSourceSchema, + explode=True, +) +SchemaFor200ResponseBodyApplicationJson = UserManagementUsers + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_users_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_users_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_users_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_users_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_page, + request_query_size, + request_query_name, + request_query_workspace, + request_query_group, + request_query_data_source, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListUsers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_users( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_users( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_users( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_users( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_users_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_users_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users/get.pyi new file mode 100644 index 000000000..8878ffe5f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users/get.pyi @@ -0,0 +1,332 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_users import UserManagementUsers + +# Query params +PageSchema = schemas.Int32Schema +SizeSchema = schemas.Int32Schema +NameSchema = schemas.StrSchema +WorkspaceSchema = schemas.StrSchema +GroupSchema = schemas.StrSchema +DataSourceSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'name': typing.Union[NameSchema, str, ], + 'workspace': typing.Union[WorkspaceSchema, str, ], + 'group': typing.Union[GroupSchema, str, ], + 'dataSource': typing.Union[DataSourceSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_name = api_client.QueryParameter( + name="name", + style=api_client.ParameterStyle.FORM, + schema=NameSchema, + explode=True, +) +request_query_workspace = api_client.QueryParameter( + name="workspace", + style=api_client.ParameterStyle.FORM, + schema=WorkspaceSchema, + explode=True, +) +request_query_group = api_client.QueryParameter( + name="group", + style=api_client.ParameterStyle.FORM, + schema=GroupSchema, + explode=True, +) +request_query_data_source = api_client.QueryParameter( + name="dataSource", + style=api_client.ParameterStyle.FORM, + schema=DataSourceSchema, + explode=True, +) +SchemaFor200ResponseBodyApplicationJson = UserManagementUsers + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_users_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_users_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_users_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_users_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_page, + request_query_size, + request_query_name, + request_query_workspace, + request_query_group, + request_query_data_source, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListUsers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_users( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_users( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_users( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_users( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_users_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_users_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users_user_id_permissions/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users_user_id_permissions/__init__.py new file mode 100644 index 000000000..6b9e84b6a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users_user_id_permissions/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_user_management_users_user_id_permissions import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_USER_MANAGEMENT_USERS_USER_ID_PERMISSIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users_user_id_permissions/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users_user_id_permissions/get.py new file mode 100644 index 000000000..495e3f2da --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users_user_id_permissions/get.py @@ -0,0 +1,292 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments + +from . import path + +# Path params +UserIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'userId': typing.Union[UserIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_user_id = api_client.PathParameter( + name="userId", + style=api_client.ParameterStyle.SIMPLE, + schema=UserIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = UserManagementPermissionAssignments + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_permissions_for_user_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_permissions_for_user_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_permissions_for_user_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_permissions_for_user_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_user_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListPermissionsForUser(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_permissions_for_user( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_permissions_for_user( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_permissions_for_user( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_permissions_for_user( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_permissions_for_user_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_permissions_for_user_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users_user_id_permissions/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users_user_id_permissions/get.pyi new file mode 100644 index 000000000..567a3fb69 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users_user_id_permissions/get.pyi @@ -0,0 +1,287 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments + +# Path params +UserIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'userId': typing.Union[UserIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_user_id = api_client.PathParameter( + name="userId", + style=api_client.ParameterStyle.SIMPLE, + schema=UserIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = UserManagementPermissionAssignments + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_permissions_for_user_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_permissions_for_user_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_permissions_for_user_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_permissions_for_user_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_user_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListPermissionsForUser(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_permissions_for_user( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_permissions_for_user( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_permissions_for_user( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_permissions_for_user( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_permissions_for_user_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_permissions_for_user_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users_user_id_permissions/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users_user_id_permissions/post.py new file mode 100644 index 000000000..6c191beee --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users_user_id_permissions/post.py @@ -0,0 +1,359 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments + +from . import path + +# Path params +UserIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'userId': typing.Union[UserIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_user_id = api_client.PathParameter( + name="userId", + style=api_client.ParameterStyle.SIMPLE, + schema=UserIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = UserManagementPermissionAssignments + + +request_body_user_management_permission_assignments = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _manage_permissions_for_user_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _manage_permissions_for_user_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _manage_permissions_for_user_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _manage_permissions_for_user_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _manage_permissions_for_user_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_user_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_user_management_permission_assignments.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ManagePermissionsForUser(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def manage_permissions_for_user( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def manage_permissions_for_user( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def manage_permissions_for_user( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def manage_permissions_for_user( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def manage_permissions_for_user( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_permissions_for_user_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_permissions_for_user_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users_user_id_permissions/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users_user_id_permissions/post.pyi new file mode 100644 index 000000000..4bb0c610c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_user_management_users_user_id_permissions/post.pyi @@ -0,0 +1,354 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.user_management_permission_assignments import UserManagementPermissionAssignments + +# Path params +UserIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'userId': typing.Union[UserIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_user_id = api_client.PathParameter( + name="userId", + style=api_client.ParameterStyle.SIMPLE, + schema=UserIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = UserManagementPermissionAssignments + + +request_body_user_management_permission_assignments = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _manage_permissions_for_user_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _manage_permissions_for_user_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _manage_permissions_for_user_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _manage_permissions_for_user_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _manage_permissions_for_user_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_user_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_user_management_permission_assignments.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ManagePermissionsForUser(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def manage_permissions_for_user( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def manage_permissions_for_user( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def manage_permissions_for_user( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def manage_permissions_for_user( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def manage_permissions_for_user( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_permissions_for_user_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_permissions_for_user_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_created_by/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_created_by/__init__.py new file mode 100644 index 000000000..f61b797d7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_created_by/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_created_by import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_ANALYTICS_CATALOG_CREATED_BY \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_created_by/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_created_by/get.py new file mode 100644 index 000000000..4d250bc06 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_created_by/get.py @@ -0,0 +1,303 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.analytics_catalog_created_by import AnalyticsCatalogCreatedBy + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = AnalyticsCatalogCreatedBy + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _created_by_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _created_by_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _created_by_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _created_by_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Analytics Catalog CreatedBy Users + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreatedBy(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def created_by( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def created_by( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def created_by( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def created_by( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._created_by_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._created_by_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_created_by/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_created_by/get.pyi new file mode 100644 index 000000000..d5427ef2f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_created_by/get.pyi @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.analytics_catalog_created_by import AnalyticsCatalogCreatedBy + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = AnalyticsCatalogCreatedBy + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _created_by_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _created_by_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _created_by_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _created_by_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Analytics Catalog CreatedBy Users + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreatedBy(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def created_by( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def created_by( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def created_by( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def created_by( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._created_by_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._created_by_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_description/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_description/__init__.py new file mode 100644 index 000000000..5fdb7adba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_description/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_description import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_ANALYTICS_CATALOG_GENERATE_DESCRIPTION \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_description/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_description/post.py new file mode 100644 index 000000000..31644ae18 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_description/post.py @@ -0,0 +1,401 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.generate_description_request import GenerateDescriptionRequest +from gooddata_api_client.model.generate_description_response import GenerateDescriptionResponse + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = GenerateDescriptionRequest + + +request_body_generate_description_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = GenerateDescriptionResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _generate_description_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _generate_description_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _generate_description_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _generate_description_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _generate_description_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Generate Description for Analytics Object + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_generate_description_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GenerateDescription(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def generate_description( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def generate_description( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def generate_description( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def generate_description( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def generate_description( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._generate_description_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._generate_description_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_description/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_description/post.pyi new file mode 100644 index 000000000..c7863efb2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_description/post.pyi @@ -0,0 +1,391 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.generate_description_request import GenerateDescriptionRequest +from gooddata_api_client.model.generate_description_response import GenerateDescriptionResponse + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = GenerateDescriptionRequest + + +request_body_generate_description_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = GenerateDescriptionResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _generate_description_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _generate_description_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _generate_description_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _generate_description_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _generate_description_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Generate Description for Analytics Object + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_generate_description_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GenerateDescription(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def generate_description( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def generate_description( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def generate_description( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def generate_description( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def generate_description( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._generate_description_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._generate_description_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_title/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_title/__init__.py new file mode 100644 index 000000000..cbe7a4785 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_title/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_title import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_ANALYTICS_CATALOG_GENERATE_TITLE \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_title/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_title/post.py new file mode 100644 index 000000000..1375517a6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_title/post.py @@ -0,0 +1,401 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.generate_title_request import GenerateTitleRequest +from gooddata_api_client.model.generate_title_response import GenerateTitleResponse + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = GenerateTitleRequest + + +request_body_generate_title_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = GenerateTitleResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _generate_title_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _generate_title_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _generate_title_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _generate_title_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _generate_title_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Generate Title for Analytics Object + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_generate_title_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GenerateTitle(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def generate_title( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def generate_title( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def generate_title( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def generate_title( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def generate_title( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._generate_title_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._generate_title_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_title/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_title/post.pyi new file mode 100644 index 000000000..e30f8008e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_generate_title/post.pyi @@ -0,0 +1,391 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.generate_title_request import GenerateTitleRequest +from gooddata_api_client.model.generate_title_response import GenerateTitleResponse + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = GenerateTitleRequest + + +request_body_generate_title_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = GenerateTitleResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _generate_title_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _generate_title_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _generate_title_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _generate_title_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _generate_title_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Generate Title for Analytics Object + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_generate_title_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GenerateTitle(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def generate_title( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def generate_title( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def generate_title( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def generate_title( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def generate_title( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._generate_title_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._generate_title_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_tags/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_tags/__init__.py new file mode 100644 index 000000000..592b49a0a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_tags/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_tags import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_ANALYTICS_CATALOG_TAGS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_tags/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_tags/get.py new file mode 100644 index 000000000..be108b688 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_tags/get.py @@ -0,0 +1,303 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.analytics_catalog_tags import AnalyticsCatalogTags + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = AnalyticsCatalogTags + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _tags_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _tags_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _tags_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _tags_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Analytics Catalog Tags + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class Tags(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def tags( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def tags( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def tags( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def tags( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._tags_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._tags_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_tags/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_tags/get.pyi new file mode 100644 index 000000000..8a12f9dcd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_analytics_catalog_tags/get.pyi @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.analytics_catalog_tags import AnalyticsCatalogTags + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = AnalyticsCatalogTags + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _tags_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _tags_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _tags_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _tags_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Analytics Catalog Tags + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class Tags(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def tags( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def tags( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def tags( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def tags( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._tags_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._tags_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat/__init__.py new file mode 100644 index 000000000..e689df8af --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_chat import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_CHAT \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat/post.py new file mode 100644 index 000000000..3d40f2b74 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat/post.py @@ -0,0 +1,401 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.chat_result import ChatResult +from gooddata_api_client.model.chat_request import ChatRequest + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ChatRequest + + +request_body_chat_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ChatResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _ai_chat_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _ai_chat_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _ai_chat_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _ai_chat_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _ai_chat_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Chat with AI + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_chat_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AiChat(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def ai_chat( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def ai_chat( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def ai_chat( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def ai_chat( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def ai_chat( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_chat_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_chat_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat/post.pyi new file mode 100644 index 000000000..ca48542a9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat/post.pyi @@ -0,0 +1,391 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.chat_result import ChatResult +from gooddata_api_client.model.chat_request import ChatRequest + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ChatRequest + + +request_body_chat_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ChatResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _ai_chat_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _ai_chat_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _ai_chat_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _ai_chat_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _ai_chat_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Chat with AI + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_chat_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AiChat(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def ai_chat( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def ai_chat( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def ai_chat( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def ai_chat( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def ai_chat( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_chat_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_chat_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_history/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_history/__init__.py new file mode 100644 index 000000000..74fb19e1c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_history/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_chat_history import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_CHAT_HISTORY \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_history/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_history/post.py new file mode 100644 index 000000000..c3f9c71fe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_history/post.py @@ -0,0 +1,401 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.chat_history_result import ChatHistoryResult +from gooddata_api_client.model.chat_history_request import ChatHistoryRequest + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ChatHistoryRequest + + +request_body_chat_history_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ChatHistoryResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _ai_chat_history_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _ai_chat_history_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _ai_chat_history_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _ai_chat_history_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _ai_chat_history_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Get Chat History + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_chat_history_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AiChatHistory(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def ai_chat_history( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def ai_chat_history( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def ai_chat_history( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def ai_chat_history( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def ai_chat_history( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_chat_history_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_chat_history_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_history/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_history/post.pyi new file mode 100644 index 000000000..21d367936 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_history/post.pyi @@ -0,0 +1,391 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.chat_history_result import ChatHistoryResult +from gooddata_api_client.model.chat_history_request import ChatHistoryRequest + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ChatHistoryRequest + + +request_body_chat_history_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ChatHistoryResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _ai_chat_history_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _ai_chat_history_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _ai_chat_history_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _ai_chat_history_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _ai_chat_history_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Get Chat History + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_chat_history_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AiChatHistory(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def ai_chat_history( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def ai_chat_history( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def ai_chat_history( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def ai_chat_history( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def ai_chat_history( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_chat_history_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_chat_history_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_stream/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_stream/__init__.py new file mode 100644 index 000000000..acb485a3c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_stream/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_chat_stream import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_CHAT_STREAM \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_stream/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_stream/post.py new file mode 100644 index 000000000..a461938dc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_stream/post.py @@ -0,0 +1,422 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.chat_request import ChatRequest + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ChatRequest + + +request_body_chat_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +class SchemaFor200ResponseBodyTextEventStream( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.DictSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyTextEventStream': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyTextEventStream, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'text/event-stream': api_client.MediaType( + schema=SchemaFor200ResponseBodyTextEventStream), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'text/event-stream', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _ai_chat_stream_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _ai_chat_stream_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _ai_chat_stream_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _ai_chat_stream_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _ai_chat_stream_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Chat with AI + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_chat_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AiChatStream(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def ai_chat_stream( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def ai_chat_stream( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def ai_chat_stream( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def ai_chat_stream( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def ai_chat_stream( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_chat_stream_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_chat_stream_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_stream/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_stream/post.pyi new file mode 100644 index 000000000..970188c36 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_stream/post.pyi @@ -0,0 +1,412 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.chat_request import ChatRequest + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ChatRequest + + +request_body_chat_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +class SchemaFor200ResponseBodyTextEventStream( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.DictSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyTextEventStream': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyTextEventStream, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'text/event-stream': api_client.MediaType( + schema=SchemaFor200ResponseBodyTextEventStream), + }, +) +_all_accept_content_types = ( + 'text/event-stream', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _ai_chat_stream_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _ai_chat_stream_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _ai_chat_stream_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _ai_chat_stream_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _ai_chat_stream_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Chat with AI + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_chat_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AiChatStream(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def ai_chat_stream( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def ai_chat_stream( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def ai_chat_stream( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def ai_chat_stream( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def ai_chat_stream( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_chat_stream_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_chat_stream_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_usage/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_usage/__init__.py new file mode 100644 index 000000000..fa5d35d13 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_usage/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_chat_usage import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_CHAT_USAGE \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_usage/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_usage/get.py new file mode 100644 index 000000000..504444f2f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_usage/get.py @@ -0,0 +1,303 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.chat_usage_response import ChatUsageResponse + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ChatUsageResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _ai_chat_usage_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _ai_chat_usage_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _ai_chat_usage_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _ai_chat_usage_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Chat Usage + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AiChatUsage(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def ai_chat_usage( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def ai_chat_usage( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def ai_chat_usage( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def ai_chat_usage( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_chat_usage_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_chat_usage_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_usage/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_usage/get.pyi new file mode 100644 index 000000000..15af09a0a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_chat_usage/get.pyi @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.chat_usage_response import ChatUsageResponse + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ChatUsageResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _ai_chat_usage_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _ai_chat_usage_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _ai_chat_usage_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _ai_chat_usage_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Chat Usage + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AiChatUsage(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def ai_chat_usage( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def ai_chat_usage( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def ai_chat_usage( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def ai_chat_usage( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_chat_usage_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_chat_usage_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues/__init__.py new file mode 100644 index 000000000..f8da39303 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_issues import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_ISSUES \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues/get.py new file mode 100644 index 000000000..6ec31f309 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues/get.py @@ -0,0 +1,303 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = GetQualityIssuesResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_quality_issues_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_quality_issues_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_quality_issues_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_quality_issues_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Quality Issues + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetQualityIssues(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_quality_issues( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_quality_issues( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_quality_issues( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_quality_issues( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_quality_issues_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_quality_issues_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues/get.pyi new file mode 100644 index 000000000..13fb32206 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues/get.pyi @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = GetQualityIssuesResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_quality_issues_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_quality_issues_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_quality_issues_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_quality_issues_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Quality Issues + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetQualityIssues(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_quality_issues( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_quality_issues( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_quality_issues( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_quality_issues( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_quality_issues_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_quality_issues_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_status_process_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_status_process_id/__init__.py new file mode 100644 index 000000000..8cbee92d1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_status_process_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_issues_status_process_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_ISSUES_STATUS_PROCESS_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_status_process_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_status_process_id/get.py new file mode 100644 index 000000000..95a50209c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_status_process_id/get.py @@ -0,0 +1,312 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.quality_issues_calculation_status_response import QualityIssuesCalculationStatusResponse + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +ProcessIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'processId': typing.Union[ProcessIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_process_id = api_client.PathParameter( + name="processId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProcessIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = QualityIssuesCalculationStatusResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_quality_issues_calculation_status_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_quality_issues_calculation_status_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_quality_issues_calculation_status_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_quality_issues_calculation_status_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Quality Issues Calculation Status + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_process_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetQualityIssuesCalculationStatus(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_quality_issues_calculation_status( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_quality_issues_calculation_status( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_quality_issues_calculation_status( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_quality_issues_calculation_status( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_quality_issues_calculation_status_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_quality_issues_calculation_status_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_status_process_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_status_process_id/get.pyi new file mode 100644 index 000000000..4af248d4b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_status_process_id/get.pyi @@ -0,0 +1,302 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.quality_issues_calculation_status_response import QualityIssuesCalculationStatusResponse + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +ProcessIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'processId': typing.Union[ProcessIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_process_id = api_client.PathParameter( + name="processId", + style=api_client.ParameterStyle.SIMPLE, + schema=ProcessIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = QualityIssuesCalculationStatusResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_quality_issues_calculation_status_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_quality_issues_calculation_status_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_quality_issues_calculation_status_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_quality_issues_calculation_status_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Quality Issues Calculation Status + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_process_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetQualityIssuesCalculationStatus(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_quality_issues_calculation_status( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_quality_issues_calculation_status( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_quality_issues_calculation_status( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_quality_issues_calculation_status( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_quality_issues_calculation_status_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_quality_issues_calculation_status_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_trigger_check/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_trigger_check/__init__.py new file mode 100644 index 000000000..a293fa391 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_trigger_check/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_issues_trigger_check import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_ISSUES_TRIGGER_CHECK \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_trigger_check/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_trigger_check/post.py new file mode 100644 index 000000000..01fcda31e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_trigger_check/post.py @@ -0,0 +1,303 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.trigger_quality_issues_calculation_response import TriggerQualityIssuesCalculationResponse + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = TriggerQualityIssuesCalculationResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _trigger_quality_issues_calculation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _trigger_quality_issues_calculation_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _trigger_quality_issues_calculation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _trigger_quality_issues_calculation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Trigger Quality Issues Calculation + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class TriggerQualityIssuesCalculation(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def trigger_quality_issues_calculation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def trigger_quality_issues_calculation( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def trigger_quality_issues_calculation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def trigger_quality_issues_calculation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._trigger_quality_issues_calculation_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._trigger_quality_issues_calculation_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_trigger_check/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_trigger_check/post.pyi new file mode 100644 index 000000000..48bf34799 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_issues_trigger_check/post.pyi @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.trigger_quality_issues_calculation_response import TriggerQualityIssuesCalculationResponse + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = TriggerQualityIssuesCalculationResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _trigger_quality_issues_calculation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _trigger_quality_issues_calculation_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _trigger_quality_issues_calculation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _trigger_quality_issues_calculation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Trigger Quality Issues Calculation + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class TriggerQualityIssuesCalculation(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def trigger_quality_issues_calculation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def trigger_quality_issues_calculation( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def trigger_quality_issues_calculation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def trigger_quality_issues_calculation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._trigger_quality_issues_calculation_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._trigger_quality_issues_calculation_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/__init__.py new file mode 100644 index 000000000..110c72abb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_knowledge_documents import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_KNOWLEDGE_DOCUMENTS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/get.py new file mode 100644 index 000000000..2f05c4705 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/get.py @@ -0,0 +1,405 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.list_knowledge_documents_response_dto import ListKnowledgeDocumentsResponseDto + +from . import path + +# Query params + + +class ScopesSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ScopesSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +SizeSchema = schemas.Int32Schema +PageTokenSchema = schemas.StrSchema +MetaIncludeSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'scopes': typing.Union[ScopesSchema, list, tuple, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'pageToken': typing.Union[PageTokenSchema, str, ], + 'metaInclude': typing.Union[MetaIncludeSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_scopes = api_client.QueryParameter( + name="scopes", + style=api_client.ParameterStyle.FORM, + schema=ScopesSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_page_token = api_client.QueryParameter( + name="pageToken", + style=api_client.ParameterStyle.FORM, + schema=PageTokenSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, + explode=True, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ListKnowledgeDocumentsResponseDto + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_documents_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_documents_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_documents_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_documents_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_scopes, + request_query_size, + request_query_page_token, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListDocuments(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_documents( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_documents( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_documents( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_documents( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_documents_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_documents_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/get.pyi new file mode 100644 index 000000000..d6b7ed1c5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/get.pyi @@ -0,0 +1,395 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.list_knowledge_documents_response_dto import ListKnowledgeDocumentsResponseDto + +# Query params + + +class ScopesSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ScopesSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +SizeSchema = schemas.Int32Schema +PageTokenSchema = schemas.StrSchema +MetaIncludeSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'scopes': typing.Union[ScopesSchema, list, tuple, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'pageToken': typing.Union[PageTokenSchema, str, ], + 'metaInclude': typing.Union[MetaIncludeSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_scopes = api_client.QueryParameter( + name="scopes", + style=api_client.ParameterStyle.FORM, + schema=ScopesSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_page_token = api_client.QueryParameter( + name="pageToken", + style=api_client.ParameterStyle.FORM, + schema=PageTokenSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, + explode=True, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ListKnowledgeDocumentsResponseDto + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_documents_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_documents_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_documents_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_documents_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_scopes, + request_query_size, + request_query_page_token, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListDocuments(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_documents( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_documents( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_documents( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_documents( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_documents_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_documents_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/post.py new file mode 100644 index 000000000..9e012d540 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/post.py @@ -0,0 +1,400 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.create_knowledge_document_response_dto import CreateKnowledgeDocumentResponseDto +from gooddata_api_client.model.create_knowledge_document_request_dto import CreateKnowledgeDocumentRequestDto + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = CreateKnowledgeDocumentRequestDto + + +request_body_create_knowledge_document_request_dto = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = CreateKnowledgeDocumentResponseDto + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _create_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _create_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_create_knowledge_document_request_dto.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateDocument(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def create_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def create_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_document_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_document_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/post.pyi new file mode 100644 index 000000000..c5329966e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/post.pyi @@ -0,0 +1,390 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.create_knowledge_document_response_dto import CreateKnowledgeDocumentResponseDto +from gooddata_api_client.model.create_knowledge_document_request_dto import CreateKnowledgeDocumentRequestDto + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = CreateKnowledgeDocumentRequestDto + + +request_body_create_knowledge_document_request_dto = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = CreateKnowledgeDocumentResponseDto + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _create_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _create_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_create_knowledge_document_request_dto.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateDocument(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def create_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def create_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_document_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_document_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/put.py new file mode 100644 index 000000000..3d608c9e5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/put.py @@ -0,0 +1,400 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.upsert_knowledge_document_response_dto import UpsertKnowledgeDocumentResponseDto +from gooddata_api_client.model.upsert_knowledge_document_request_dto import UpsertKnowledgeDocumentRequestDto + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = UpsertKnowledgeDocumentRequestDto + + +request_body_upsert_knowledge_document_request_dto = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = UpsertKnowledgeDocumentResponseDto + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _upsert_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _upsert_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _upsert_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _upsert_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _upsert_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_upsert_knowledge_document_request_dto.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpsertDocument(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def upsert_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def upsert_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def upsert_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def upsert_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def upsert_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._upsert_document_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._upsert_document_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/put.pyi new file mode 100644 index 000000000..7bf4f194d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents/put.pyi @@ -0,0 +1,390 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.upsert_knowledge_document_response_dto import UpsertKnowledgeDocumentResponseDto +from gooddata_api_client.model.upsert_knowledge_document_request_dto import UpsertKnowledgeDocumentRequestDto + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = UpsertKnowledgeDocumentRequestDto + + +request_body_upsert_knowledge_document_request_dto = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = UpsertKnowledgeDocumentResponseDto + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _upsert_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _upsert_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _upsert_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _upsert_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _upsert_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_upsert_knowledge_document_request_dto.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpsertDocument(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def upsert_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def upsert_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def upsert_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def upsert_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def upsert_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._upsert_document_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._upsert_document_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/__init__.py new file mode 100644 index 000000000..8b2d1839e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_KNOWLEDGE_DOCUMENTS_FILENAME \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/delete.py new file mode 100644 index 000000000..de16d94b0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/delete.py @@ -0,0 +1,311 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.delete_knowledge_document_response_dto import DeleteKnowledgeDocumentResponseDto + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +FilenameSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'filename': typing.Union[FilenameSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_filename = api_client.PathParameter( + name="filename", + style=api_client.ParameterStyle.SIMPLE, + schema=FilenameSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = DeleteKnowledgeDocumentResponseDto + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_document_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _delete_document_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_document_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_document_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_filename, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteDocument(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_document( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def delete_document( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_document( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_document( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_document_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_document_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/delete.pyi new file mode 100644 index 000000000..83c1ca956 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/delete.pyi @@ -0,0 +1,301 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.delete_knowledge_document_response_dto import DeleteKnowledgeDocumentResponseDto + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +FilenameSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'filename': typing.Union[FilenameSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_filename = api_client.PathParameter( + name="filename", + style=api_client.ParameterStyle.SIMPLE, + schema=FilenameSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = DeleteKnowledgeDocumentResponseDto + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_document_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _delete_document_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_document_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_document_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_filename, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteDocument(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_document( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def delete_document( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_document( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_document( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_document_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_document_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/get.py new file mode 100644 index 000000000..6182a8de8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/get.py @@ -0,0 +1,311 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.knowledge_document_metadata_dto import KnowledgeDocumentMetadataDto + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +FilenameSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'filename': typing.Union[FilenameSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_filename = api_client.PathParameter( + name="filename", + style=api_client.ParameterStyle.SIMPLE, + schema=FilenameSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = KnowledgeDocumentMetadataDto + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_document_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_document_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_document_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_document_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_filename, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetDocument(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_document( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_document( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_document( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_document( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_document_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_document_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/get.pyi new file mode 100644 index 000000000..504c92cde --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/get.pyi @@ -0,0 +1,301 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.knowledge_document_metadata_dto import KnowledgeDocumentMetadataDto + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +FilenameSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'filename': typing.Union[FilenameSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_filename = api_client.PathParameter( + name="filename", + style=api_client.ParameterStyle.SIMPLE, + schema=FilenameSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = KnowledgeDocumentMetadataDto + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_document_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_document_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_document_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_document_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_filename, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetDocument(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_document( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_document( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_document( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_document( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_document_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_document_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/patch.py new file mode 100644 index 000000000..1132995ee --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/patch.py @@ -0,0 +1,409 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.knowledge_document_metadata_dto import KnowledgeDocumentMetadataDto +from gooddata_api_client.model.patch_knowledge_document_request_dto import PatchKnowledgeDocumentRequestDto + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +FilenameSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'filename': typing.Union[FilenameSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_filename = api_client.PathParameter( + name="filename", + style=api_client.ParameterStyle.SIMPLE, + schema=FilenameSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = PatchKnowledgeDocumentRequestDto + + +request_body_patch_knowledge_document_request_dto = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = KnowledgeDocumentMetadataDto + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_filename, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_patch_knowledge_document_request_dto.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchDocument(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_document_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_document_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/patch.pyi new file mode 100644 index 000000000..382bd7cab --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_documents_filename/patch.pyi @@ -0,0 +1,399 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.knowledge_document_metadata_dto import KnowledgeDocumentMetadataDto +from gooddata_api_client.model.patch_knowledge_document_request_dto import PatchKnowledgeDocumentRequestDto + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +FilenameSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'filename': typing.Union[FilenameSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_filename = api_client.PathParameter( + name="filename", + style=api_client.ParameterStyle.SIMPLE, + schema=FilenameSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = PatchKnowledgeDocumentRequestDto + + +request_body_patch_knowledge_document_request_dto = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = KnowledgeDocumentMetadataDto + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_document_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_filename, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_patch_knowledge_document_request_dto.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchDocument(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_document( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_document_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_document_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_search/__init__.py new file mode 100644 index 000000000..c290e6593 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_knowledge_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_KNOWLEDGE_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_search/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_search/get.py new file mode 100644 index 000000000..dabf67a25 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_search/get.py @@ -0,0 +1,406 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.search_knowledge_response_dto import SearchKnowledgeResponseDto + +from . import path + +# Query params +QuerySchema = schemas.StrSchema +LimitSchema = schemas.Int32Schema +MinScoreSchema = schemas.Float64Schema + + +class ScopesSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ScopesSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + 'query': typing.Union[QuerySchema, str, ], + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'limit': typing.Union[LimitSchema, decimal.Decimal, int, ], + 'minScore': typing.Union[MinScoreSchema, decimal.Decimal, int, float, ], + 'scopes': typing.Union[ScopesSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_query = api_client.QueryParameter( + name="query", + style=api_client.ParameterStyle.FORM, + schema=QuerySchema, + required=True, + explode=True, +) +request_query_limit = api_client.QueryParameter( + name="limit", + style=api_client.ParameterStyle.FORM, + schema=LimitSchema, + explode=True, +) +request_query_min_score = api_client.QueryParameter( + name="minScore", + style=api_client.ParameterStyle.FORM, + schema=MinScoreSchema, + explode=True, +) +request_query_scopes = api_client.QueryParameter( + name="scopes", + style=api_client.ParameterStyle.FORM, + schema=ScopesSchema, + explode=True, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = SearchKnowledgeResponseDto + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_knowledge_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_knowledge_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_knowledge_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_knowledge_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_query, + request_query_limit, + request_query_min_score, + request_query_scopes, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchKnowledge(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_knowledge( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_knowledge( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_knowledge( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_knowledge( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_knowledge_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_knowledge_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_search/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_search/get.pyi new file mode 100644 index 000000000..aa6886032 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_knowledge_search/get.pyi @@ -0,0 +1,396 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.search_knowledge_response_dto import SearchKnowledgeResponseDto + +# Query params +QuerySchema = schemas.StrSchema +LimitSchema = schemas.Int32Schema +MinScoreSchema = schemas.Float64Schema + + +class ScopesSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ScopesSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + 'query': typing.Union[QuerySchema, str, ], + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'limit': typing.Union[LimitSchema, decimal.Decimal, int, ], + 'minScore': typing.Union[MinScoreSchema, decimal.Decimal, int, float, ], + 'scopes': typing.Union[ScopesSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_query = api_client.QueryParameter( + name="query", + style=api_client.ParameterStyle.FORM, + schema=QuerySchema, + required=True, + explode=True, +) +request_query_limit = api_client.QueryParameter( + name="limit", + style=api_client.ParameterStyle.FORM, + schema=LimitSchema, + explode=True, +) +request_query_min_score = api_client.QueryParameter( + name="minScore", + style=api_client.ParameterStyle.FORM, + schema=MinScoreSchema, + explode=True, +) +request_query_scopes = api_client.QueryParameter( + name="scopes", + style=api_client.ParameterStyle.FORM, + schema=ScopesSchema, + explode=True, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = SearchKnowledgeResponseDto + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_knowledge_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_knowledge_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_knowledge_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_knowledge_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_query, + request_query_limit, + request_query_min_score, + request_query_scopes, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchKnowledge(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_knowledge( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_knowledge( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_knowledge( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_knowledge( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_knowledge_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_knowledge_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_memory_created_by/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_memory_created_by/__init__.py new file mode 100644 index 000000000..fc0e9debd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_memory_created_by/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_memory_created_by import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_MEMORY_CREATED_BY \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_memory_created_by/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_memory_created_by/get.py new file mode 100644 index 000000000..733c4b275 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_memory_created_by/get.py @@ -0,0 +1,303 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.memory_item_created_by_users import MemoryItemCreatedByUsers + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = MemoryItemCreatedByUsers + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _memory_created_by_users_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _memory_created_by_users_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _memory_created_by_users_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _memory_created_by_users_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get AI Memory CreatedBy Users + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class MemoryCreatedByUsers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def memory_created_by_users( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def memory_created_by_users( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def memory_created_by_users( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def memory_created_by_users( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._memory_created_by_users_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._memory_created_by_users_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_memory_created_by/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_memory_created_by/get.pyi new file mode 100644 index 000000000..b327ae87a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_memory_created_by/get.pyi @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.memory_item_created_by_users import MemoryItemCreatedByUsers + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = MemoryItemCreatedByUsers + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _memory_created_by_users_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _memory_created_by_users_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _memory_created_by_users_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _memory_created_by_users_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get AI Memory CreatedBy Users + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class MemoryCreatedByUsers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def memory_created_by_users( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def memory_created_by_users( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def memory_created_by_users( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def memory_created_by_users( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._memory_created_by_users_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._memory_created_by_users_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_resolve_llm_endpoints/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_resolve_llm_endpoints/__init__.py new file mode 100644 index 000000000..2b5e854db --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_resolve_llm_endpoints/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_resolve_llm_endpoints import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_RESOLVE_LLM_ENDPOINTS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_resolve_llm_endpoints/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_resolve_llm_endpoints/get.py new file mode 100644 index 000000000..8e009e12f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_resolve_llm_endpoints/get.py @@ -0,0 +1,303 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.resolved_llm_endpoints import ResolvedLlmEndpoints + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ResolvedLlmEndpoints + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _resolve_llm_endpoints_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _resolve_llm_endpoints_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _resolve_llm_endpoints_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _resolve_llm_endpoints_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Active LLM Endpoints for this workspace + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ResolveLlmEndpoints(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def resolve_llm_endpoints( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def resolve_llm_endpoints( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def resolve_llm_endpoints( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def resolve_llm_endpoints( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._resolve_llm_endpoints_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._resolve_llm_endpoints_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_resolve_llm_endpoints/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_resolve_llm_endpoints/get.pyi new file mode 100644 index 000000000..03b968ff6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_resolve_llm_endpoints/get.pyi @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.resolved_llm_endpoints import ResolvedLlmEndpoints + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ResolvedLlmEndpoints + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _resolve_llm_endpoints_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _resolve_llm_endpoints_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _resolve_llm_endpoints_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _resolve_llm_endpoints_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Active LLM Endpoints for this workspace + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ResolveLlmEndpoints(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def resolve_llm_endpoints( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def resolve_llm_endpoints( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def resolve_llm_endpoints( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def resolve_llm_endpoints( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._resolve_llm_endpoints_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._resolve_llm_endpoints_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_search/__init__.py new file mode 100644 index 000000000..f7001be91 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_ai_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AI_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_search/post.py new file mode 100644 index 000000000..c424cbb5b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_search/post.py @@ -0,0 +1,401 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.search_result import SearchResult +from gooddata_api_client.model.search_request import SearchRequest + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = SearchRequest + + +request_body_search_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = SearchResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _ai_search_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _ai_search_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _ai_search_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _ai_search_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _ai_search_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Semantic Search in Metadata + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_search_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AiSearch(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def ai_search( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def ai_search( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def ai_search( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def ai_search( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def ai_search( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_search_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_search_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_search/post.pyi new file mode 100644 index 000000000..2c5e3f35b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_ai_search/post.pyi @@ -0,0 +1,391 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.search_result import SearchResult +from gooddata_api_client.model.search_request import SearchRequest + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = SearchRequest + + +request_body_search_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = SearchResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _ai_search_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _ai_search_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _ai_search_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _ai_search_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _ai_search_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Semantic Search in Metadata + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_search_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AiSearch(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def ai_search( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def ai_search( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def ai_search( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def ai_search( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def ai_search( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_search_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._ai_search_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_export_tabular/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_export_tabular/__init__.py new file mode 100644 index 000000000..9cadd4fd4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_export_tabular/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_export_tabular import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_ANALYTICAL_DASHBOARDS_DASHBOARD_ID_EXPORT_TABULAR \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_export_tabular/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_export_tabular/post.py new file mode 100644 index 000000000..437a2d9ac --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_export_tabular/post.py @@ -0,0 +1,400 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.export_response import ExportResponse +from gooddata_api_client.model.dashboard_tabular_export_request import DashboardTabularExportRequest + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +DashboardIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'dashboardId': typing.Union[DashboardIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_dashboard_id = api_client.PathParameter( + name="dashboardId", + style=api_client.ParameterStyle.SIMPLE, + schema=DashboardIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = DashboardTabularExportRequest + + +request_body_dashboard_tabular_export_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = ExportResponse + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_dashboard_export_request_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_dashboard_export_request_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_dashboard_export_request_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_dashboard_export_request_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_dashboard_export_request_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Create dashboard tabular export request + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_dashboard_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_dashboard_tabular_export_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateDashboardExportRequest(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_dashboard_export_request( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_dashboard_export_request( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_dashboard_export_request( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_dashboard_export_request( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_dashboard_export_request( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_dashboard_export_request_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_dashboard_export_request_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_export_tabular/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_export_tabular/post.pyi new file mode 100644 index 000000000..ef1235155 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_analytical_dashboards_dashboard_id_export_tabular/post.pyi @@ -0,0 +1,395 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.export_response import ExportResponse +from gooddata_api_client.model.dashboard_tabular_export_request import DashboardTabularExportRequest + +# Path params +WorkspaceIdSchema = schemas.StrSchema +DashboardIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'dashboardId': typing.Union[DashboardIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_dashboard_id = api_client.PathParameter( + name="dashboardId", + style=api_client.ParameterStyle.SIMPLE, + schema=DashboardIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = DashboardTabularExportRequest + + +request_body_dashboard_tabular_export_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = ExportResponse + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_dashboard_export_request_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_dashboard_export_request_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_dashboard_export_request_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_dashboard_export_request_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_dashboard_export_request_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Create dashboard tabular export request + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_dashboard_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_dashboard_tabular_export_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateDashboardExportRequest(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_dashboard_export_request( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_dashboard_export_request( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_dashboard_export_request( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_dashboard_export_request( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_dashboard_export_request( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_dashboard_export_request_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_dashboard_export_request_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_trigger/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_trigger/__init__.py new file mode 100644 index 000000000..0707c30ac --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_trigger/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_automation_id_trigger import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AUTOMATIONS_AUTOMATION_ID_TRIGGER \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_trigger/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_trigger/post.py new file mode 100644 index 000000000..b11c873ad --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_trigger/post.py @@ -0,0 +1,269 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +AutomationIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'automationId': typing.Union[AutomationIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_automation_id = api_client.PathParameter( + name="automationId", + style=api_client.ParameterStyle.SIMPLE, + schema=AutomationIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _trigger_existing_automation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _trigger_existing_automation_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _trigger_existing_automation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _trigger_existing_automation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Trigger existing automation. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_automation_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class TriggerExistingAutomation(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def trigger_existing_automation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def trigger_existing_automation( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def trigger_existing_automation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def trigger_existing_automation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._trigger_existing_automation_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._trigger_existing_automation_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_trigger/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_trigger/post.pyi new file mode 100644 index 000000000..b5ec6047b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_trigger/post.pyi @@ -0,0 +1,264 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Path params +WorkspaceIdSchema = schemas.StrSchema +AutomationIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'automationId': typing.Union[AutomationIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_automation_id = api_client.PathParameter( + name="automationId", + style=api_client.ParameterStyle.SIMPLE, + schema=AutomationIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _trigger_existing_automation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _trigger_existing_automation_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _trigger_existing_automation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _trigger_existing_automation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Trigger existing automation. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_automation_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class TriggerExistingAutomation(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def trigger_existing_automation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def trigger_existing_automation( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def trigger_existing_automation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def trigger_existing_automation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._trigger_existing_automation_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._trigger_existing_automation_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_unsubscribe/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_unsubscribe/__init__.py new file mode 100644 index 000000000..c8f6081a2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_unsubscribe/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_automation_id_unsubscribe import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AUTOMATIONS_AUTOMATION_ID_UNSUBSCRIBE \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_unsubscribe/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_unsubscribe/delete.py new file mode 100644 index 000000000..cbb11528c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_unsubscribe/delete.py @@ -0,0 +1,269 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +AutomationIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'automationId': typing.Union[AutomationIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_automation_id = api_client.PathParameter( + name="automationId", + style=api_client.ParameterStyle.SIMPLE, + schema=AutomationIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _unsubscribe_automation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _unsubscribe_automation_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _unsubscribe_automation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _unsubscribe_automation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Unsubscribe from an automation + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_automation_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UnsubscribeAutomation(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def unsubscribe_automation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def unsubscribe_automation( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def unsubscribe_automation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def unsubscribe_automation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_automation_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_automation_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_unsubscribe/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_unsubscribe/delete.pyi new file mode 100644 index 000000000..72e0a48bf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_automation_id_unsubscribe/delete.pyi @@ -0,0 +1,264 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Path params +WorkspaceIdSchema = schemas.StrSchema +AutomationIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'automationId': typing.Union[AutomationIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_automation_id = api_client.PathParameter( + name="automationId", + style=api_client.ParameterStyle.SIMPLE, + schema=AutomationIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _unsubscribe_automation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _unsubscribe_automation_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _unsubscribe_automation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _unsubscribe_automation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Unsubscribe from an automation + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_automation_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UnsubscribeAutomation(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def unsubscribe_automation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def unsubscribe_automation( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def unsubscribe_automation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def unsubscribe_automation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_automation_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_automation_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_delete/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_delete/__init__.py new file mode 100644 index 000000000..832d3b7e8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_delete/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_delete import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AUTOMATIONS_DELETE \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_delete/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_delete/post.py new file mode 100644 index 000000000..bb54f8726 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_delete/post.py @@ -0,0 +1,360 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = WorkspaceAutomationManagementBulkRequest + + +request_body_workspace_automation_management_bulk_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _delete_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete selected automations in the workspace + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_workspace_automation_management_bulk_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteWorkspaceAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def delete_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_workspace_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_workspace_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_delete/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_delete/post.pyi new file mode 100644 index 000000000..994e91d07 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_delete/post.pyi @@ -0,0 +1,355 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = WorkspaceAutomationManagementBulkRequest + + +request_body_workspace_automation_management_bulk_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _delete_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete selected automations in the workspace + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_workspace_automation_management_bulk_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteWorkspaceAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def delete_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_workspace_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_workspace_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_pause/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_pause/__init__.py new file mode 100644 index 000000000..f4c48d119 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_pause/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_pause import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AUTOMATIONS_PAUSE \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_pause/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_pause/post.py new file mode 100644 index 000000000..ae8916fd1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_pause/post.py @@ -0,0 +1,360 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = WorkspaceAutomationManagementBulkRequest + + +request_body_workspace_automation_management_bulk_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _pause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _pause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _pause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _pause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _pause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Pause selected automations in the workspace + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_workspace_automation_management_bulk_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PauseWorkspaceAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def pause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def pause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def pause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def pause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def pause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._pause_workspace_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._pause_workspace_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_pause/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_pause/post.pyi new file mode 100644 index 000000000..9d9183aa0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_pause/post.pyi @@ -0,0 +1,355 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = WorkspaceAutomationManagementBulkRequest + + +request_body_workspace_automation_management_bulk_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _pause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _pause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _pause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _pause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _pause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Pause selected automations in the workspace + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_workspace_automation_management_bulk_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PauseWorkspaceAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def pause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def pause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def pause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def pause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def pause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._pause_workspace_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._pause_workspace_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_trigger/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_trigger/__init__.py new file mode 100644 index 000000000..5f5300c09 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_trigger/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_trigger import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AUTOMATIONS_TRIGGER \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_trigger/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_trigger/post.py new file mode 100644 index 000000000..1c300124c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_trigger/post.py @@ -0,0 +1,360 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.trigger_automation_request import TriggerAutomationRequest + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = TriggerAutomationRequest + + +request_body_trigger_automation_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _trigger_automation_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _trigger_automation_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _trigger_automation_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _trigger_automation_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _trigger_automation_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Trigger automation. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_trigger_automation_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class TriggerAutomation(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def trigger_automation( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def trigger_automation( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def trigger_automation( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def trigger_automation( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def trigger_automation( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._trigger_automation_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._trigger_automation_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_trigger/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_trigger/post.pyi new file mode 100644 index 000000000..325043f6e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_trigger/post.pyi @@ -0,0 +1,355 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.trigger_automation_request import TriggerAutomationRequest + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = TriggerAutomationRequest + + +request_body_trigger_automation_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _trigger_automation_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _trigger_automation_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _trigger_automation_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _trigger_automation_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _trigger_automation_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Trigger automation. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_trigger_automation_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class TriggerAutomation(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def trigger_automation( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def trigger_automation( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def trigger_automation( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def trigger_automation( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def trigger_automation( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._trigger_automation_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._trigger_automation_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unpause/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unpause/__init__.py new file mode 100644 index 000000000..301d7058a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unpause/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_unpause import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AUTOMATIONS_UNPAUSE \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unpause/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unpause/post.py new file mode 100644 index 000000000..40f6778d8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unpause/post.py @@ -0,0 +1,360 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = WorkspaceAutomationManagementBulkRequest + + +request_body_workspace_automation_management_bulk_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _unpause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _unpause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _unpause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _unpause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _unpause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Unpause selected automations in the workspace + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_workspace_automation_management_bulk_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UnpauseWorkspaceAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def unpause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def unpause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def unpause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def unpause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def unpause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unpause_workspace_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unpause_workspace_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unpause/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unpause/post.pyi new file mode 100644 index 000000000..9182d7e04 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unpause/post.pyi @@ -0,0 +1,355 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = WorkspaceAutomationManagementBulkRequest + + +request_body_workspace_automation_management_bulk_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _unpause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _unpause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _unpause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _unpause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _unpause_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Unpause selected automations in the workspace + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_workspace_automation_management_bulk_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UnpauseWorkspaceAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def unpause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def unpause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def unpause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def unpause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def unpause_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unpause_workspace_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unpause_workspace_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe/__init__.py new file mode 100644 index 000000000..5a2bc7d76 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_automations_unsubscribe import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_AUTOMATIONS_UNSUBSCRIBE \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe/delete.py new file mode 100644 index 000000000..2e41442ad --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe/delete.py @@ -0,0 +1,260 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _unsubscribe_workspace_automations_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _unsubscribe_workspace_automations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _unsubscribe_workspace_automations_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _unsubscribe_workspace_automations_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Unsubscribe from all automations in the workspace + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UnsubscribeWorkspaceAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def unsubscribe_workspace_automations( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def unsubscribe_workspace_automations( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def unsubscribe_workspace_automations( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def unsubscribe_workspace_automations( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_workspace_automations_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_workspace_automations_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe/delete.pyi new file mode 100644 index 000000000..0ed29263f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe/delete.pyi @@ -0,0 +1,255 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _unsubscribe_workspace_automations_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _unsubscribe_workspace_automations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _unsubscribe_workspace_automations_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _unsubscribe_workspace_automations_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Unsubscribe from all automations in the workspace + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UnsubscribeWorkspaceAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def unsubscribe_workspace_automations( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def unsubscribe_workspace_automations( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def unsubscribe_workspace_automations( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def unsubscribe_workspace_automations( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_workspace_automations_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_workspace_automations_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe/post.py new file mode 100644 index 000000000..707d36e6f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe/post.py @@ -0,0 +1,360 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = WorkspaceAutomationManagementBulkRequest + + +request_body_workspace_automation_management_bulk_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _unsubscribe_selected_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _unsubscribe_selected_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _unsubscribe_selected_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _unsubscribe_selected_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _unsubscribe_selected_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Unsubscribe from selected automations in the workspace + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_workspace_automation_management_bulk_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UnsubscribeSelectedWorkspaceAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def unsubscribe_selected_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def unsubscribe_selected_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def unsubscribe_selected_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def unsubscribe_selected_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def unsubscribe_selected_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_selected_workspace_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_selected_workspace_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe/post.pyi new file mode 100644 index 000000000..e39fe4573 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_automations_unsubscribe/post.pyi @@ -0,0 +1,355 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = WorkspaceAutomationManagementBulkRequest + + +request_body_workspace_automation_management_bulk_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _unsubscribe_selected_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _unsubscribe_selected_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _unsubscribe_selected_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _unsubscribe_selected_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _unsubscribe_selected_workspace_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Unsubscribe from selected automations in the workspace + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_workspace_automation_management_bulk_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UnsubscribeSelectedWorkspaceAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def unsubscribe_selected_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def unsubscribe_selected_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def unsubscribe_selected_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def unsubscribe_selected_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def unsubscribe_selected_workspace_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_selected_workspace_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._unsubscribe_selected_workspace_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_cancel/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_cancel/__init__.py new file mode 100644 index 000000000..e5a1f6083 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_cancel/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_afm_cancel import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXECUTION_AFM_CANCEL \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_cancel/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_cancel/post.py new file mode 100644 index 000000000..b7757d246 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_cancel/post.py @@ -0,0 +1,400 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = AfmCancelTokens + + +request_body_afm_cancel_tokens = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = AfmCancelTokens + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _cancel_executions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _cancel_executions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _cancel_executions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _cancel_executions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _cancel_executions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Applies all the given cancel tokens. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_afm_cancel_tokens.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CancelExecutions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def cancel_executions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def cancel_executions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def cancel_executions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def cancel_executions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def cancel_executions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._cancel_executions_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._cancel_executions_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_cancel/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_cancel/post.pyi new file mode 100644 index 000000000..2e5e52791 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_cancel/post.pyi @@ -0,0 +1,390 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = AfmCancelTokens + + +request_body_afm_cancel_tokens = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = AfmCancelTokens + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _cancel_executions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _cancel_executions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _cancel_executions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _cancel_executions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _cancel_executions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Applies all the given cancel tokens. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_afm_cancel_tokens.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CancelExecutions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def cancel_executions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def cancel_executions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def cancel_executions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def cancel_executions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def cancel_executions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._cancel_executions_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._cancel_executions_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_descendants/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_descendants/__init__.py new file mode 100644 index 000000000..41da7f28d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_descendants/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_descendants import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXECUTION_AFM_COMPUTE_VALID_DESCENDANTS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_descendants/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_descendants/post.py new file mode 100644 index 000000000..f50d8686b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_descendants/post.py @@ -0,0 +1,401 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.afm_valid_descendants_query import AfmValidDescendantsQuery +from gooddata_api_client.model.afm_valid_descendants_response import AfmValidDescendantsResponse + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = AfmValidDescendantsQuery + + +request_body_afm_valid_descendants_query = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = AfmValidDescendantsResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _compute_valid_descendants_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _compute_valid_descendants_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _compute_valid_descendants_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _compute_valid_descendants_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _compute_valid_descendants_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Valid descendants + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_afm_valid_descendants_query.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ComputeValidDescendants(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def compute_valid_descendants( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def compute_valid_descendants( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def compute_valid_descendants( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def compute_valid_descendants( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def compute_valid_descendants( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._compute_valid_descendants_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._compute_valid_descendants_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_descendants/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_descendants/post.pyi new file mode 100644 index 000000000..e56281383 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_afm_compute_valid_descendants/post.pyi @@ -0,0 +1,391 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.afm_valid_descendants_query import AfmValidDescendantsQuery +from gooddata_api_client.model.afm_valid_descendants_response import AfmValidDescendantsResponse + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = AfmValidDescendantsQuery + + +request_body_afm_valid_descendants_query = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = AfmValidDescendantsResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _compute_valid_descendants_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _compute_valid_descendants_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _compute_valid_descendants_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _compute_valid_descendants_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _compute_valid_descendants_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Valid descendants + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_afm_valid_descendants_query.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ComputeValidDescendants(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def compute_valid_descendants( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def compute_valid_descendants( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def compute_valid_descendants( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def compute_valid_descendants( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def compute_valid_descendants( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._compute_valid_descendants_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._compute_valid_descendants_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis/__init__.py new file mode 100644 index 000000000..f5abf0dff --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXECUTION_COMPUTE_CHANGE_ANALYSIS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis/post.py new file mode 100644 index 000000000..3fd7c4eb5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis/post.py @@ -0,0 +1,401 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.change_analysis_response import ChangeAnalysisResponse +from gooddata_api_client.model.change_analysis_request import ChangeAnalysisRequest + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ChangeAnalysisRequest + + +request_body_change_analysis_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ChangeAnalysisResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _change_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _change_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _change_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _change_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _change_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Compute change analysis + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_change_analysis_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ChangeAnalysis(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def change_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def change_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def change_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def change_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def change_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._change_analysis_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._change_analysis_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis/post.pyi new file mode 100644 index 000000000..c6728be74 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis/post.pyi @@ -0,0 +1,391 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.change_analysis_response import ChangeAnalysisResponse +from gooddata_api_client.model.change_analysis_request import ChangeAnalysisRequest + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ChangeAnalysisRequest + + +request_body_change_analysis_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ChangeAnalysisResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _change_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _change_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _change_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _change_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _change_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Compute change analysis + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_change_analysis_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ChangeAnalysis(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def change_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def change_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def change_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def change_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def change_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._change_analysis_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._change_analysis_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis_result_result_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis_result_result_id/__init__.py new file mode 100644 index 000000000..a623c6dd5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis_result_result_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis_result_result_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXECUTION_COMPUTE_CHANGE_ANALYSIS_RESULT_RESULT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis_result_result_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis_result_result_id/get.py new file mode 100644 index 000000000..1dc87498a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis_result_result_id/get.py @@ -0,0 +1,312 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.change_analysis_result import ChangeAnalysisResult + +from . import path + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ChangeAnalysisResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _change_analysis_result_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _change_analysis_result_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _change_analysis_result_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _change_analysis_result_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get change analysis result + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ChangeAnalysisResult(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def change_analysis_result( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def change_analysis_result( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def change_analysis_result( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def change_analysis_result( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._change_analysis_result_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._change_analysis_result_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis_result_result_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis_result_result_id/get.pyi new file mode 100644 index 000000000..f45036b25 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_change_analysis_result_result_id/get.pyi @@ -0,0 +1,302 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.change_analysis_result import ChangeAnalysisResult + +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ChangeAnalysisResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _change_analysis_result_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _change_analysis_result_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _change_analysis_result_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _change_analysis_result_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get change analysis result + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ChangeAnalysisResult(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def change_analysis_result( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def change_analysis_result( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def change_analysis_result( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def change_analysis_result( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._change_analysis_result_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._change_analysis_result_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers/__init__.py new file mode 100644 index 000000000..4fe95c3fd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXECUTION_COMPUTE_KEY_DRIVERS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers/post.py new file mode 100644 index 000000000..6af6e108a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers/post.py @@ -0,0 +1,452 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.key_drivers_response import KeyDriversResponse +from gooddata_api_client.model.key_drivers_request import KeyDriversRequest + +from . import path + +# Header params +SkipCacheSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'skip-cache': typing.Union[SkipCacheSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_skip_cache = api_client.HeaderParameter( + name="skip-cache", + style=api_client.ParameterStyle.SIMPLE, + schema=SkipCacheSchema, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = KeyDriversRequest + + +request_body_key_drivers_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = KeyDriversResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _key_driver_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _key_driver_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _key_driver_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _key_driver_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _key_driver_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Compute key driver analysis + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_skip_cache, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_key_drivers_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class KeyDriverAnalysis(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def key_driver_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def key_driver_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def key_driver_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def key_driver_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def key_driver_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._key_driver_analysis_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._key_driver_analysis_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers/post.pyi new file mode 100644 index 000000000..1fbdfc66f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers/post.pyi @@ -0,0 +1,442 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.key_drivers_response import KeyDriversResponse +from gooddata_api_client.model.key_drivers_request import KeyDriversRequest + +# Header params +SkipCacheSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'skip-cache': typing.Union[SkipCacheSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_skip_cache = api_client.HeaderParameter( + name="skip-cache", + style=api_client.ParameterStyle.SIMPLE, + schema=SkipCacheSchema, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = KeyDriversRequest + + +request_body_key_drivers_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = KeyDriversResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _key_driver_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _key_driver_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _key_driver_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _key_driver_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _key_driver_analysis_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Compute key driver analysis + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_skip_cache, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_key_drivers_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class KeyDriverAnalysis(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def key_driver_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def key_driver_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def key_driver_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def key_driver_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def key_driver_analysis( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._key_driver_analysis_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._key_driver_analysis_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers_result_result_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers_result_result_id/__init__.py new file mode 100644 index 000000000..9589bbf26 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers_result_result_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers_result_result_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXECUTION_COMPUTE_KEY_DRIVERS_RESULT_RESULT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers_result_result_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers_result_result_id/get.py new file mode 100644 index 000000000..94e9d8771 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers_result_result_id/get.py @@ -0,0 +1,375 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.key_drivers_result import KeyDriversResult + +from . import path + +# Query params +OffsetSchema = schemas.Int32Schema +LimitSchema = schemas.Int32Schema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'offset': typing.Union[OffsetSchema, decimal.Decimal, int, ], + 'limit': typing.Union[LimitSchema, decimal.Decimal, int, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_offset = api_client.QueryParameter( + name="offset", + style=api_client.ParameterStyle.FORM, + schema=OffsetSchema, + explode=True, +) +request_query_limit = api_client.QueryParameter( + name="limit", + style=api_client.ParameterStyle.FORM, + schema=LimitSchema, + explode=True, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = KeyDriversResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _key_driver_analysis_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _key_driver_analysis_result_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _key_driver_analysis_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _key_driver_analysis_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Get key driver analysis result + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_offset, + request_query_limit, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class KeyDriverAnalysisResult(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def key_driver_analysis_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def key_driver_analysis_result( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def key_driver_analysis_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def key_driver_analysis_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._key_driver_analysis_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._key_driver_analysis_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers_result_result_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers_result_result_id/get.pyi new file mode 100644 index 000000000..913ab9537 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_compute_key_drivers_result_result_id/get.pyi @@ -0,0 +1,365 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.key_drivers_result import KeyDriversResult + +# Query params +OffsetSchema = schemas.Int32Schema +LimitSchema = schemas.Int32Schema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'offset': typing.Union[OffsetSchema, decimal.Decimal, int, ], + 'limit': typing.Union[LimitSchema, decimal.Decimal, int, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_offset = api_client.QueryParameter( + name="offset", + style=api_client.ParameterStyle.FORM, + schema=OffsetSchema, + explode=True, +) +request_query_limit = api_client.QueryParameter( + name="limit", + style=api_client.ParameterStyle.FORM, + schema=LimitSchema, + explode=True, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = KeyDriversResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _key_driver_analysis_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _key_driver_analysis_result_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _key_driver_analysis_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _key_driver_analysis_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Get key driver analysis result + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_offset, + request_query_limit, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class KeyDriverAnalysisResult(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def key_driver_analysis_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def key_driver_analysis_result( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def key_driver_analysis_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def key_driver_analysis_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._key_driver_analysis_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._key_driver_analysis_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers/__init__.py new file mode 100644 index 000000000..6341784c1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_detect_outliers import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXECUTION_DETECT_OUTLIERS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers/post.py new file mode 100644 index 000000000..f6bd01b65 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers/post.py @@ -0,0 +1,452 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.outlier_detection_request import OutlierDetectionRequest +from gooddata_api_client.model.outlier_detection_response import OutlierDetectionResponse + +from . import path + +# Header params +SkipCacheSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'skip-cache': typing.Union[SkipCacheSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_skip_cache = api_client.HeaderParameter( + name="skip-cache", + style=api_client.ParameterStyle.SIMPLE, + schema=SkipCacheSchema, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = OutlierDetectionRequest + + +request_body_outlier_detection_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = OutlierDetectionResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _outlier_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _outlier_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _outlier_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _outlier_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _outlier_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Outlier Detection + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_skip_cache, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_outlier_detection_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class OutlierDetection(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def outlier_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def outlier_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def outlier_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def outlier_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def outlier_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._outlier_detection_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._outlier_detection_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers/post.pyi new file mode 100644 index 000000000..7adf42986 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers/post.pyi @@ -0,0 +1,442 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.outlier_detection_request import OutlierDetectionRequest +from gooddata_api_client.model.outlier_detection_response import OutlierDetectionResponse + +# Header params +SkipCacheSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'skip-cache': typing.Union[SkipCacheSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_skip_cache = api_client.HeaderParameter( + name="skip-cache", + style=api_client.ParameterStyle.SIMPLE, + schema=SkipCacheSchema, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = OutlierDetectionRequest + + +request_body_outlier_detection_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = OutlierDetectionResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _outlier_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _outlier_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _outlier_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _outlier_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _outlier_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Outlier Detection + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_skip_cache, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_outlier_detection_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class OutlierDetection(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def outlier_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def outlier_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def outlier_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def outlier_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def outlier_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._outlier_detection_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._outlier_detection_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers_result_result_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers_result_result_id/__init__.py new file mode 100644 index 000000000..0c92010e9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers_result_result_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_detect_outliers_result_result_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXECUTION_DETECT_OUTLIERS_RESULT_RESULT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers_result_result_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers_result_result_id/get.py new file mode 100644 index 000000000..1fd136320 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers_result_result_id/get.py @@ -0,0 +1,375 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.outlier_detection_result import OutlierDetectionResult + +from . import path + +# Query params +OffsetSchema = schemas.Int32Schema +LimitSchema = schemas.Int32Schema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'offset': typing.Union[OffsetSchema, decimal.Decimal, int, ], + 'limit': typing.Union[LimitSchema, decimal.Decimal, int, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_offset = api_client.QueryParameter( + name="offset", + style=api_client.ParameterStyle.FORM, + schema=OffsetSchema, + explode=True, +) +request_query_limit = api_client.QueryParameter( + name="limit", + style=api_client.ParameterStyle.FORM, + schema=LimitSchema, + explode=True, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = OutlierDetectionResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _outlier_detection_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _outlier_detection_result_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _outlier_detection_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _outlier_detection_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Outlier Detection Result + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_offset, + request_query_limit, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class OutlierDetectionResult(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def outlier_detection_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def outlier_detection_result( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def outlier_detection_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def outlier_detection_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._outlier_detection_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._outlier_detection_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers_result_result_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers_result_result_id/get.pyi new file mode 100644 index 000000000..6af83f653 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_detect_outliers_result_result_id/get.pyi @@ -0,0 +1,365 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.outlier_detection_result import OutlierDetectionResult + +# Query params +OffsetSchema = schemas.Int32Schema +LimitSchema = schemas.Int32Schema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'offset': typing.Union[OffsetSchema, decimal.Decimal, int, ], + 'limit': typing.Union[LimitSchema, decimal.Decimal, int, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_offset = api_client.QueryParameter( + name="offset", + style=api_client.ParameterStyle.FORM, + schema=OffsetSchema, + explode=True, +) +request_query_limit = api_client.QueryParameter( + name="limit", + style=api_client.ParameterStyle.FORM, + schema=LimitSchema, + explode=True, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = OutlierDetectionResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _outlier_detection_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _outlier_detection_result_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _outlier_detection_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _outlier_detection_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Outlier Detection Result + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_offset, + request_query_limit, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class OutlierDetectionResult(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def outlier_detection_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def outlier_detection_result( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def outlier_detection_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def outlier_detection_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._outlier_detection_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._outlier_detection_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_id/__init__.py new file mode 100644 index 000000000..969ddd2b6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXECUTION_FUNCTIONS_ANOMALY_DETECTION_RESULT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_id/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_id/post.py new file mode 100644 index 000000000..71ab47e32 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_id/post.py @@ -0,0 +1,461 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.anomaly_detection_request import AnomalyDetectionRequest +from gooddata_api_client.model.smart_function_response import SmartFunctionResponse + +from . import path + +# Header params +SkipCacheSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'skip-cache': typing.Union[SkipCacheSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_skip_cache = api_client.HeaderParameter( + name="skip-cache", + style=api_client.ParameterStyle.SIMPLE, + schema=SkipCacheSchema, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = AnomalyDetectionRequest + + +request_body_anomaly_detection_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = SmartFunctionResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _anomaly_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _anomaly_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _anomaly_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _anomaly_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _anomaly_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Smart functions - Anomaly Detection + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_skip_cache, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_anomaly_detection_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AnomalyDetection(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def anomaly_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def anomaly_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def anomaly_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def anomaly_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def anomaly_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._anomaly_detection_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._anomaly_detection_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_id/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_id/post.pyi new file mode 100644 index 000000000..b6b6259d7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_id/post.pyi @@ -0,0 +1,451 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.anomaly_detection_request import AnomalyDetectionRequest +from gooddata_api_client.model.smart_function_response import SmartFunctionResponse + +# Header params +SkipCacheSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'skip-cache': typing.Union[SkipCacheSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_skip_cache = api_client.HeaderParameter( + name="skip-cache", + style=api_client.ParameterStyle.SIMPLE, + schema=SkipCacheSchema, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = AnomalyDetectionRequest + + +request_body_anomaly_detection_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = SmartFunctionResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _anomaly_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _anomaly_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _anomaly_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _anomaly_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _anomaly_detection_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Smart functions - Anomaly Detection + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_skip_cache, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_anomaly_detection_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AnomalyDetection(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def anomaly_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def anomaly_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def anomaly_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def anomaly_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def anomaly_detection( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._anomaly_detection_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._anomaly_detection_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_result_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_result_id/__init__.py new file mode 100644 index 000000000..be44f600d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_result_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_result_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXECUTION_FUNCTIONS_ANOMALY_DETECTION_RESULT_RESULT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_result_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_result_id/get.py new file mode 100644 index 000000000..83378b639 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_result_id/get.py @@ -0,0 +1,375 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.anomaly_detection_result import AnomalyDetectionResult + +from . import path + +# Query params +OffsetSchema = schemas.Int32Schema +LimitSchema = schemas.Int32Schema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'offset': typing.Union[OffsetSchema, decimal.Decimal, int, ], + 'limit': typing.Union[LimitSchema, decimal.Decimal, int, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_offset = api_client.QueryParameter( + name="offset", + style=api_client.ParameterStyle.FORM, + schema=OffsetSchema, + explode=True, +) +request_query_limit = api_client.QueryParameter( + name="limit", + style=api_client.ParameterStyle.FORM, + schema=LimitSchema, + explode=True, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = AnomalyDetectionResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _anomaly_detection_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _anomaly_detection_result_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _anomaly_detection_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _anomaly_detection_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Smart functions - Anomaly Detection Result + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_offset, + request_query_limit, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AnomalyDetectionResult(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def anomaly_detection_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def anomaly_detection_result( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def anomaly_detection_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def anomaly_detection_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._anomaly_detection_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._anomaly_detection_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_result_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_result_id/get.pyi new file mode 100644 index 000000000..6889ba1b0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_anomaly_detection_result_result_id/get.pyi @@ -0,0 +1,365 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.anomaly_detection_result import AnomalyDetectionResult + +# Query params +OffsetSchema = schemas.Int32Schema +LimitSchema = schemas.Int32Schema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'offset': typing.Union[OffsetSchema, decimal.Decimal, int, ], + 'limit': typing.Union[LimitSchema, decimal.Decimal, int, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_offset = api_client.QueryParameter( + name="offset", + style=api_client.ParameterStyle.FORM, + schema=OffsetSchema, + explode=True, +) +request_query_limit = api_client.QueryParameter( + name="limit", + style=api_client.ParameterStyle.FORM, + schema=LimitSchema, + explode=True, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = AnomalyDetectionResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _anomaly_detection_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _anomaly_detection_result_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _anomaly_detection_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _anomaly_detection_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Smart functions - Anomaly Detection Result + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_offset, + request_query_limit, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class AnomalyDetectionResult(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def anomaly_detection_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def anomaly_detection_result( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def anomaly_detection_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def anomaly_detection_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._anomaly_detection_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._anomaly_detection_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_id/__init__.py new file mode 100644 index 000000000..50f2e08cb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXECUTION_FUNCTIONS_CLUSTERING_RESULT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_id/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_id/post.py new file mode 100644 index 000000000..f0ec25352 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_id/post.py @@ -0,0 +1,461 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.clustering_request import ClusteringRequest +from gooddata_api_client.model.smart_function_response import SmartFunctionResponse + +from . import path + +# Header params +SkipCacheSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'skip-cache': typing.Union[SkipCacheSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_skip_cache = api_client.HeaderParameter( + name="skip-cache", + style=api_client.ParameterStyle.SIMPLE, + schema=SkipCacheSchema, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ClusteringRequest + + +request_body_clustering_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = SmartFunctionResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _clustering_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _clustering_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _clustering_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _clustering_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _clustering_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Smart functions - Clustering + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_skip_cache, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_clustering_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class Clustering(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def clustering( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def clustering( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def clustering( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def clustering( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def clustering( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._clustering_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._clustering_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_id/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_id/post.pyi new file mode 100644 index 000000000..0605de147 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_id/post.pyi @@ -0,0 +1,451 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.clustering_request import ClusteringRequest +from gooddata_api_client.model.smart_function_response import SmartFunctionResponse + +# Header params +SkipCacheSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'skip-cache': typing.Union[SkipCacheSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_skip_cache = api_client.HeaderParameter( + name="skip-cache", + style=api_client.ParameterStyle.SIMPLE, + schema=SkipCacheSchema, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ClusteringRequest + + +request_body_clustering_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = SmartFunctionResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _clustering_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _clustering_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _clustering_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _clustering_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _clustering_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Smart functions - Clustering + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_skip_cache, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_clustering_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class Clustering(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def clustering( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def clustering( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def clustering( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def clustering( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def clustering( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._clustering_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._clustering_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_result_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_result_id/__init__.py new file mode 100644 index 000000000..90b16815f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_result_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_result_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXECUTION_FUNCTIONS_CLUSTERING_RESULT_RESULT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_result_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_result_id/get.py new file mode 100644 index 000000000..633c08ce9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_result_id/get.py @@ -0,0 +1,375 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.clustering_result import ClusteringResult + +from . import path + +# Query params +OffsetSchema = schemas.Int32Schema +LimitSchema = schemas.Int32Schema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'offset': typing.Union[OffsetSchema, decimal.Decimal, int, ], + 'limit': typing.Union[LimitSchema, decimal.Decimal, int, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_offset = api_client.QueryParameter( + name="offset", + style=api_client.ParameterStyle.FORM, + schema=OffsetSchema, + explode=True, +) +request_query_limit = api_client.QueryParameter( + name="limit", + style=api_client.ParameterStyle.FORM, + schema=LimitSchema, + explode=True, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ClusteringResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _clustering_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _clustering_result_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _clustering_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _clustering_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Smart functions - Clustering Result + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_offset, + request_query_limit, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ClusteringResult(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def clustering_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def clustering_result( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def clustering_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def clustering_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._clustering_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._clustering_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_result_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_result_id/get.pyi new file mode 100644 index 000000000..a07232efe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_clustering_result_result_id/get.pyi @@ -0,0 +1,365 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.clustering_result import ClusteringResult + +# Query params +OffsetSchema = schemas.Int32Schema +LimitSchema = schemas.Int32Schema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'offset': typing.Union[OffsetSchema, decimal.Decimal, int, ], + 'limit': typing.Union[LimitSchema, decimal.Decimal, int, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_offset = api_client.QueryParameter( + name="offset", + style=api_client.ParameterStyle.FORM, + schema=OffsetSchema, + explode=True, +) +request_query_limit = api_client.QueryParameter( + name="limit", + style=api_client.ParameterStyle.FORM, + schema=LimitSchema, + explode=True, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ClusteringResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _clustering_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _clustering_result_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _clustering_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _clustering_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Smart functions - Clustering Result + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_offset, + request_query_limit, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ClusteringResult(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def clustering_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def clustering_result( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def clustering_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def clustering_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._clustering_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._clustering_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_id/__init__.py new file mode 100644 index 000000000..c54e6edb7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXECUTION_FUNCTIONS_FORECAST_RESULT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_id/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_id/post.py new file mode 100644 index 000000000..a0f292dcb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_id/post.py @@ -0,0 +1,461 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.forecast_request import ForecastRequest +from gooddata_api_client.model.smart_function_response import SmartFunctionResponse + +from . import path + +# Header params +SkipCacheSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'skip-cache': typing.Union[SkipCacheSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_skip_cache = api_client.HeaderParameter( + name="skip-cache", + style=api_client.ParameterStyle.SIMPLE, + schema=SkipCacheSchema, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ForecastRequest + + +request_body_forecast_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = SmartFunctionResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _forecast_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _forecast_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _forecast_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _forecast_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _forecast_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Smart functions - Forecast + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_skip_cache, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_forecast_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class Forecast(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def forecast( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def forecast( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def forecast( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def forecast( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def forecast( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._forecast_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._forecast_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_id/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_id/post.pyi new file mode 100644 index 000000000..b69e2b0be --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_id/post.pyi @@ -0,0 +1,451 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.forecast_request import ForecastRequest +from gooddata_api_client.model.smart_function_response import SmartFunctionResponse + +# Header params +SkipCacheSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'skip-cache': typing.Union[SkipCacheSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_skip_cache = api_client.HeaderParameter( + name="skip-cache", + style=api_client.ParameterStyle.SIMPLE, + schema=SkipCacheSchema, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ForecastRequest + + +request_body_forecast_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = SmartFunctionResponse + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _forecast_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _forecast_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _forecast_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _forecast_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _forecast_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Smart functions - Forecast + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_skip_cache, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_forecast_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class Forecast(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def forecast( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def forecast( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def forecast( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def forecast( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def forecast( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._forecast_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._forecast_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_result_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_result_id/__init__.py new file mode 100644 index 000000000..c843bfb3e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_result_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_result_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXECUTION_FUNCTIONS_FORECAST_RESULT_RESULT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_result_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_result_id/get.py new file mode 100644 index 000000000..8a25c4860 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_result_id/get.py @@ -0,0 +1,375 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.forecast_result import ForecastResult + +from . import path + +# Query params +OffsetSchema = schemas.Int32Schema +LimitSchema = schemas.Int32Schema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'offset': typing.Union[OffsetSchema, decimal.Decimal, int, ], + 'limit': typing.Union[LimitSchema, decimal.Decimal, int, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_offset = api_client.QueryParameter( + name="offset", + style=api_client.ParameterStyle.FORM, + schema=OffsetSchema, + explode=True, +) +request_query_limit = api_client.QueryParameter( + name="limit", + style=api_client.ParameterStyle.FORM, + schema=LimitSchema, + explode=True, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ForecastResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _forecast_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _forecast_result_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _forecast_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _forecast_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Smart functions - Forecast Result + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_offset, + request_query_limit, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ForecastResult(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def forecast_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def forecast_result( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def forecast_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def forecast_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._forecast_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._forecast_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_result_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_result_id/get.pyi new file mode 100644 index 000000000..c03ecf196 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_execution_functions_forecast_result_result_id/get.pyi @@ -0,0 +1,365 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.forecast_result import ForecastResult + +# Query params +OffsetSchema = schemas.Int32Schema +LimitSchema = schemas.Int32Schema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'offset': typing.Union[OffsetSchema, decimal.Decimal, int, ], + 'limit': typing.Union[LimitSchema, decimal.Decimal, int, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_offset = api_client.QueryParameter( + name="offset", + style=api_client.ParameterStyle.FORM, + schema=OffsetSchema, + explode=True, +) +request_query_limit = api_client.QueryParameter( + name="limit", + style=api_client.ParameterStyle.FORM, + schema=LimitSchema, + explode=True, +) +# Path params + + +class WorkspaceIdSchema( + schemas.StrSchema +): + pass +ResultIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'resultId': typing.Union[ResultIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_result_id = api_client.PathParameter( + name="resultId", + style=api_client.ParameterStyle.SIMPLE, + schema=ResultIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = ForecastResult + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _forecast_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _forecast_result_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _forecast_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _forecast_result_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Smart functions - Forecast Result + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_result_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_offset, + request_query_limit, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ForecastResult(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def forecast_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def forecast_result( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def forecast_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def forecast_result( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._forecast_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._forecast_result_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image/__init__.py new file mode 100644 index 000000000..86e22daa1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_image import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXPORT_IMAGE \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image/post.py new file mode 100644 index 000000000..514952de5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image/post.py @@ -0,0 +1,391 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.export_response import ExportResponse +from gooddata_api_client.model.image_export_request import ImageExportRequest + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ImageExportRequest + + +request_body_image_export_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = ExportResponse + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_image_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_image_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_image_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_image_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_image_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Create image export request + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_image_export_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateImageExport(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_image_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_image_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_image_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_image_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_image_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_image_export_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_image_export_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image/post.pyi new file mode 100644 index 000000000..06e1132c9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image/post.pyi @@ -0,0 +1,386 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.export_response import ExportResponse +from gooddata_api_client.model.image_export_request import ImageExportRequest + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = ImageExportRequest + + +request_body_image_export_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = ExportResponse + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_image_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_image_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_image_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_image_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_image_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Create image export request + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_image_export_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateImageExport(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_image_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_image_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_image_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_image_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_image_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_image_export_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_image_export_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id/__init__.py new file mode 100644 index 000000000..1ae6563c4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_image_export_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXPORT_IMAGE_EXPORT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id/get.py new file mode 100644 index 000000000..3e91f0db3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id/get.py @@ -0,0 +1,488 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +ExportIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'exportId': typing.Union[ExportIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_export_id = api_client.PathParameter( + name="exportId", + style=api_client.ParameterStyle.SIMPLE, + schema=ExportIdSchema, + required=True, +) + + +class ContentDispositionSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'attachment; filename='[^']+'', # noqa: E501 + }] +content_disposition_parameter = api_client.HeaderParameter( + name="Content-Disposition", + style=api_client.ParameterStyle.SIMPLE, + schema=ContentDispositionSchema, +) +SchemaFor200ResponseBodyImagePng = schemas.BinarySchema +ResponseHeadersFor200 = typing_extensions.TypedDict( + 'ResponseHeadersFor200', + { + 'Content-Disposition': ContentDispositionSchema, + } +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyImagePng, + ] + headers: ResponseHeadersFor200 + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'image/png': api_client.MediaType( + schema=SchemaFor200ResponseBodyImagePng), + }, + headers=[ + content_disposition_parameter, + ] +) + + +class SchemaFor202ResponseBodyImagePng( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + char = schemas.StrSchema + direct = schemas.BoolSchema + double = schemas.Float64Schema + _float = schemas.Float32Schema + _int = schemas.Int32Schema + long = schemas.Int64Schema + readOnly = schemas.BoolSchema + short = schemas.Int32Schema + __annotations__ = { + "char": char, + "direct": direct, + "double": double, + "float": _float, + "int": _int, + "long": long, + "readOnly": readOnly, + "short": short, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["char"]) -> MetaOapg.properties.char: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["direct"]) -> MetaOapg.properties.direct: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["double"]) -> MetaOapg.properties.double: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["float"]) -> MetaOapg.properties._float: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["int"]) -> MetaOapg.properties._int: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["long"]) -> MetaOapg.properties.long: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["readOnly"]) -> MetaOapg.properties.readOnly: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["short"]) -> MetaOapg.properties.short: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["char", "direct", "double", "float", "int", "long", "readOnly", "short", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["char"]) -> typing.Union[MetaOapg.properties.char, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["direct"]) -> typing.Union[MetaOapg.properties.direct, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["double"]) -> typing.Union[MetaOapg.properties.double, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["float"]) -> typing.Union[MetaOapg.properties._float, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["int"]) -> typing.Union[MetaOapg.properties._int, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["long"]) -> typing.Union[MetaOapg.properties.long, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["readOnly"]) -> typing.Union[MetaOapg.properties.readOnly, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["short"]) -> typing.Union[MetaOapg.properties.short, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["char", "direct", "double", "float", "int", "long", "readOnly", "short", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + char: typing.Union[MetaOapg.properties.char, str, schemas.Unset] = schemas.unset, + direct: typing.Union[MetaOapg.properties.direct, bool, schemas.Unset] = schemas.unset, + double: typing.Union[MetaOapg.properties.double, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + long: typing.Union[MetaOapg.properties.long, decimal.Decimal, int, schemas.Unset] = schemas.unset, + readOnly: typing.Union[MetaOapg.properties.readOnly, bool, schemas.Unset] = schemas.unset, + short: typing.Union[MetaOapg.properties.short, decimal.Decimal, int, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + char=char, + direct=direct, + double=double, + long=long, + readOnly=readOnly, + short=short, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor202ResponseBodyImagePng': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor202(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor202ResponseBodyImagePng, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_202 = api_client.OpenApiResponse( + response_cls=ApiResponseFor202, + content={ + 'image/png': api_client.MediaType( + schema=SchemaFor202ResponseBodyImagePng), + }, +) +_status_code_to_response = { + '200': _response_for_200, + '202': _response_for_202, +} +_all_accept_content_types = ( + 'image/png', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_image_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def _get_image_export_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_image_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_image_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Retrieve exported files + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_export_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetImageExport(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_image_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def get_image_export( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_image_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_image_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_image_export_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_image_export_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id/get.pyi new file mode 100644 index 000000000..49b4cef36 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id/get.pyi @@ -0,0 +1,472 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Path params +WorkspaceIdSchema = schemas.StrSchema +ExportIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'exportId': typing.Union[ExportIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_export_id = api_client.PathParameter( + name="exportId", + style=api_client.ParameterStyle.SIMPLE, + schema=ExportIdSchema, + required=True, +) + + +class ContentDispositionSchema( + schemas.StrSchema +): + pass +SchemaFor200ResponseBodyImagePng = schemas.BinarySchema +ResponseHeadersFor200 = typing_extensions.TypedDict( + 'ResponseHeadersFor200', + { + 'Content-Disposition': ContentDispositionSchema, + } +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyImagePng, + ] + headers: ResponseHeadersFor200 + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'image/png': api_client.MediaType( + schema=SchemaFor200ResponseBodyImagePng), + }, + headers=[ + content_disposition_parameter, + ] +) + + +class SchemaFor202ResponseBodyImagePng( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + char = schemas.StrSchema + direct = schemas.BoolSchema + double = schemas.Float64Schema + _float = schemas.Float32Schema + _int = schemas.Int32Schema + long = schemas.Int64Schema + readOnly = schemas.BoolSchema + short = schemas.Int32Schema + __annotations__ = { + "char": char, + "direct": direct, + "double": double, + "float": _float, + "int": _int, + "long": long, + "readOnly": readOnly, + "short": short, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["char"]) -> MetaOapg.properties.char: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["direct"]) -> MetaOapg.properties.direct: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["double"]) -> MetaOapg.properties.double: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["float"]) -> MetaOapg.properties._float: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["int"]) -> MetaOapg.properties._int: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["long"]) -> MetaOapg.properties.long: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["readOnly"]) -> MetaOapg.properties.readOnly: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["short"]) -> MetaOapg.properties.short: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["char", "direct", "double", "float", "int", "long", "readOnly", "short", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["char"]) -> typing.Union[MetaOapg.properties.char, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["direct"]) -> typing.Union[MetaOapg.properties.direct, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["double"]) -> typing.Union[MetaOapg.properties.double, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["float"]) -> typing.Union[MetaOapg.properties._float, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["int"]) -> typing.Union[MetaOapg.properties._int, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["long"]) -> typing.Union[MetaOapg.properties.long, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["readOnly"]) -> typing.Union[MetaOapg.properties.readOnly, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["short"]) -> typing.Union[MetaOapg.properties.short, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["char", "direct", "double", "float", "int", "long", "readOnly", "short", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + char: typing.Union[MetaOapg.properties.char, str, schemas.Unset] = schemas.unset, + direct: typing.Union[MetaOapg.properties.direct, bool, schemas.Unset] = schemas.unset, + double: typing.Union[MetaOapg.properties.double, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + long: typing.Union[MetaOapg.properties.long, decimal.Decimal, int, schemas.Unset] = schemas.unset, + readOnly: typing.Union[MetaOapg.properties.readOnly, bool, schemas.Unset] = schemas.unset, + short: typing.Union[MetaOapg.properties.short, decimal.Decimal, int, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + char=char, + direct=direct, + double=double, + long=long, + readOnly=readOnly, + short=short, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor202ResponseBodyImagePng': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor202(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor202ResponseBodyImagePng, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_202 = api_client.OpenApiResponse( + response_cls=ApiResponseFor202, + content={ + 'image/png': api_client.MediaType( + schema=SchemaFor202ResponseBodyImagePng), + }, +) +_all_accept_content_types = ( + 'image/png', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_image_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def _get_image_export_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_image_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_image_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Retrieve exported files + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_export_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetImageExport(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_image_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def get_image_export( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_image_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_image_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_image_export_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_image_export_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id_metadata/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id_metadata/__init__.py new file mode 100644 index 000000000..21e14fab2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id_metadata/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_image_export_id_metadata import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXPORT_IMAGE_EXPORT_ID_METADATA \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id_metadata/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id_metadata/get.py new file mode 100644 index 000000000..d4f24d938 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id_metadata/get.py @@ -0,0 +1,298 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +ExportIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'exportId': typing.Union[ExportIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_export_id = api_client.PathParameter( + name="exportId", + style=api_client.ParameterStyle.SIMPLE, + schema=ExportIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + schemas.Unset, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType(), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_image_export_metadata_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_image_export_metadata_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_image_export_metadata_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_image_export_metadata_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Retrieve metadata context + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_export_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetImageExportMetadata(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_image_export_metadata( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_image_export_metadata( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_image_export_metadata( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_image_export_metadata( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_image_export_metadata_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_image_export_metadata_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id_metadata/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id_metadata/get.pyi new file mode 100644 index 000000000..578fb8aae --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_image_export_id_metadata/get.pyi @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Path params +WorkspaceIdSchema = schemas.StrSchema +ExportIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'exportId': typing.Union[ExportIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_export_id = api_client.PathParameter( + name="exportId", + style=api_client.ParameterStyle.SIMPLE, + schema=ExportIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + schemas.Unset, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType(), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_image_export_metadata_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_image_export_metadata_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_image_export_metadata_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_image_export_metadata_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Retrieve metadata context + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_export_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetImageExportMetadata(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_image_export_metadata( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_image_export_metadata( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_image_export_metadata( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_image_export_metadata( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_image_export_metadata_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_image_export_metadata_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw/__init__.py new file mode 100644 index 000000000..e942ac411 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_raw import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXPORT_RAW \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw/post.py new file mode 100644 index 000000000..1cf549cfe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw/post.py @@ -0,0 +1,391 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.export_response import ExportResponse +from gooddata_api_client.model.raw_export_request import RawExportRequest + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = RawExportRequest + + +request_body_raw_export_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = ExportResponse + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_raw_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_raw_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_raw_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_raw_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_raw_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Create raw export request + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_raw_export_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateRawExport(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_raw_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_raw_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_raw_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_raw_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_raw_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_raw_export_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_raw_export_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw/post.pyi new file mode 100644 index 000000000..b716f88a3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw/post.pyi @@ -0,0 +1,386 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.export_response import ExportResponse +from gooddata_api_client.model.raw_export_request import RawExportRequest + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = RawExportRequest + + +request_body_raw_export_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = ExportResponse + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_raw_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_raw_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_raw_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_raw_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_raw_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Create raw export request + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_raw_export_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateRawExport(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_raw_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_raw_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_raw_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_raw_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_raw_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_raw_export_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_raw_export_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw_export_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw_export_id/__init__.py new file mode 100644 index 000000000..2350d6fec --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw_export_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_raw_export_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXPORT_RAW_EXPORT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw_export_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw_export_id/get.py new file mode 100644 index 000000000..f8a1a6751 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw_export_id/get.py @@ -0,0 +1,369 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +ExportIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'exportId': typing.Union[ExportIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_export_id = api_client.PathParameter( + name="exportId", + style=api_client.ParameterStyle.SIMPLE, + schema=ExportIdSchema, + required=True, +) + + +class ContentDispositionSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'attachment; filename='[^']+'', # noqa: E501 + }] +content_disposition_parameter = api_client.HeaderParameter( + name="Content-Disposition", + style=api_client.ParameterStyle.SIMPLE, + schema=ContentDispositionSchema, +) +SchemaFor200ResponseBodyApplicationVndApacheArrowFile = schemas.BinarySchema +SchemaFor200ResponseBodyApplicationVndApacheArrowStream = schemas.BinarySchema +SchemaFor200ResponseBodyTextCsv = schemas.BinarySchema +ResponseHeadersFor200 = typing_extensions.TypedDict( + 'ResponseHeadersFor200', + { + 'Content-Disposition': ContentDispositionSchema, + } +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndApacheArrowFile, + SchemaFor200ResponseBodyApplicationVndApacheArrowStream, + SchemaFor200ResponseBodyTextCsv, + ] + headers: ResponseHeadersFor200 + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.apache.arrow.file': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndApacheArrowFile), + 'application/vnd.apache.arrow.stream': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndApacheArrowStream), + 'text/csv': api_client.MediaType( + schema=SchemaFor200ResponseBodyTextCsv), + }, + headers=[ + content_disposition_parameter, + ] +) +SchemaFor202ResponseBodyApplicationVndApacheArrowFile = schemas.BinarySchema +SchemaFor202ResponseBodyApplicationVndApacheArrowStream = schemas.BinarySchema +SchemaFor202ResponseBodyTextCsv = schemas.BinarySchema + + +@dataclass +class ApiResponseFor202(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor202ResponseBodyApplicationVndApacheArrowFile, + SchemaFor202ResponseBodyApplicationVndApacheArrowStream, + SchemaFor202ResponseBodyTextCsv, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_202 = api_client.OpenApiResponse( + response_cls=ApiResponseFor202, + content={ + 'application/vnd.apache.arrow.file': api_client.MediaType( + schema=SchemaFor202ResponseBodyApplicationVndApacheArrowFile), + 'application/vnd.apache.arrow.stream': api_client.MediaType( + schema=SchemaFor202ResponseBodyApplicationVndApacheArrowStream), + 'text/csv': api_client.MediaType( + schema=SchemaFor202ResponseBodyTextCsv), + }, +) +_status_code_to_response = { + '200': _response_for_200, + '202': _response_for_202, +} +_all_accept_content_types = ( + 'application/vnd.apache.arrow.file', + 'application/vnd.apache.arrow.stream', + 'text/csv', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_raw_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def _get_raw_export_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_raw_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_raw_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Retrieve exported files + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_export_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetRawExport(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_raw_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def get_raw_export( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_raw_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_raw_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_raw_export_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_raw_export_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw_export_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw_export_id/get.pyi new file mode 100644 index 000000000..68c095871 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_raw_export_id/get.pyi @@ -0,0 +1,353 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Path params +WorkspaceIdSchema = schemas.StrSchema +ExportIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'exportId': typing.Union[ExportIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_export_id = api_client.PathParameter( + name="exportId", + style=api_client.ParameterStyle.SIMPLE, + schema=ExportIdSchema, + required=True, +) + + +class ContentDispositionSchema( + schemas.StrSchema +): + pass +SchemaFor200ResponseBodyApplicationVndApacheArrowFile = schemas.BinarySchema +SchemaFor200ResponseBodyApplicationVndApacheArrowStream = schemas.BinarySchema +SchemaFor200ResponseBodyTextCsv = schemas.BinarySchema +ResponseHeadersFor200 = typing_extensions.TypedDict( + 'ResponseHeadersFor200', + { + 'Content-Disposition': ContentDispositionSchema, + } +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationVndApacheArrowFile, + SchemaFor200ResponseBodyApplicationVndApacheArrowStream, + SchemaFor200ResponseBodyTextCsv, + ] + headers: ResponseHeadersFor200 + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/vnd.apache.arrow.file': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndApacheArrowFile), + 'application/vnd.apache.arrow.stream': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndApacheArrowStream), + 'text/csv': api_client.MediaType( + schema=SchemaFor200ResponseBodyTextCsv), + }, + headers=[ + content_disposition_parameter, + ] +) +SchemaFor202ResponseBodyApplicationVndApacheArrowFile = schemas.BinarySchema +SchemaFor202ResponseBodyApplicationVndApacheArrowStream = schemas.BinarySchema +SchemaFor202ResponseBodyTextCsv = schemas.BinarySchema + + +@dataclass +class ApiResponseFor202(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor202ResponseBodyApplicationVndApacheArrowFile, + SchemaFor202ResponseBodyApplicationVndApacheArrowStream, + SchemaFor202ResponseBodyTextCsv, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_202 = api_client.OpenApiResponse( + response_cls=ApiResponseFor202, + content={ + 'application/vnd.apache.arrow.file': api_client.MediaType( + schema=SchemaFor202ResponseBodyApplicationVndApacheArrowFile), + 'application/vnd.apache.arrow.stream': api_client.MediaType( + schema=SchemaFor202ResponseBodyApplicationVndApacheArrowStream), + 'text/csv': api_client.MediaType( + schema=SchemaFor202ResponseBodyTextCsv), + }, +) +_all_accept_content_types = ( + 'application/vnd.apache.arrow.file', + 'application/vnd.apache.arrow.stream', + 'text/csv', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_raw_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def _get_raw_export_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_raw_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_raw_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Retrieve exported files + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_export_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetRawExport(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_raw_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def get_raw_export( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_raw_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_raw_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_raw_export_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_raw_export_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides/__init__.py new file mode 100644 index 000000000..9278418ec --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_slides import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXPORT_SLIDES \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides/post.py new file mode 100644 index 000000000..e4d872355 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides/post.py @@ -0,0 +1,442 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.export_response import ExportResponse +from gooddata_api_client.model.slides_export_request import SlidesExportRequest + +from . import path + +# Header params +XGdcDebugSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-Gdc-Debug': typing.Union[XGdcDebugSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_debug = api_client.HeaderParameter( + name="X-Gdc-Debug", + style=api_client.ParameterStyle.SIMPLE, + schema=XGdcDebugSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = SlidesExportRequest + + +request_body_slides_export_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = ExportResponse + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_slides_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_slides_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_slides_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_slides_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_slides_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Create slides export request + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_debug, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_slides_export_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateSlidesExport(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_slides_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_slides_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_slides_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_slides_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_slides_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_slides_export_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_slides_export_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides/post.pyi new file mode 100644 index 000000000..44b00965f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides/post.pyi @@ -0,0 +1,437 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.export_response import ExportResponse +from gooddata_api_client.model.slides_export_request import SlidesExportRequest + +# Header params +XGdcDebugSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-Gdc-Debug': typing.Union[XGdcDebugSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_debug = api_client.HeaderParameter( + name="X-Gdc-Debug", + style=api_client.ParameterStyle.SIMPLE, + schema=XGdcDebugSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = SlidesExportRequest + + +request_body_slides_export_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = ExportResponse + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_slides_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_slides_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_slides_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_slides_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_slides_export_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Create slides export request + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_debug, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_slides_export_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateSlidesExport(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_slides_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_slides_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_slides_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_slides_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_slides_export( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_slides_export_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_slides_export_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id/__init__.py new file mode 100644 index 000000000..83401ce98 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_slides_export_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXPORT_SLIDES_EXPORT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id/get.py new file mode 100644 index 000000000..19d3217f5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id/get.py @@ -0,0 +1,639 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +ExportIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'exportId': typing.Union[ExportIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_export_id = api_client.PathParameter( + name="exportId", + style=api_client.ParameterStyle.SIMPLE, + schema=ExportIdSchema, + required=True, +) + + +class ContentDispositionSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'attachment; filename='[^']+'', # noqa: E501 + }] +content_disposition_parameter = api_client.HeaderParameter( + name="Content-Disposition", + style=api_client.ParameterStyle.SIMPLE, + schema=ContentDispositionSchema, +) +SchemaFor200ResponseBodyApplicationPdf = schemas.BinarySchema +SchemaFor200ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation = schemas.BinarySchema +SchemaFor200ResponseBodyApplicationZip = schemas.BinarySchema +ResponseHeadersFor200 = typing_extensions.TypedDict( + 'ResponseHeadersFor200', + { + 'Content-Disposition': ContentDispositionSchema, + } +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationPdf, + SchemaFor200ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation, + SchemaFor200ResponseBodyApplicationZip, + ] + headers: ResponseHeadersFor200 + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/pdf': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationPdf), + 'application/vnd.openxmlformats-officedocument.presentationml.presentation': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation), + 'application/zip': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationZip), + }, + headers=[ + content_disposition_parameter, + ] +) + + +class SchemaFor202ResponseBodyApplicationPdf( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + char = schemas.StrSchema + direct = schemas.BoolSchema + double = schemas.Float64Schema + _float = schemas.Float32Schema + _int = schemas.Int32Schema + long = schemas.Int64Schema + readOnly = schemas.BoolSchema + short = schemas.Int32Schema + __annotations__ = { + "char": char, + "direct": direct, + "double": double, + "float": _float, + "int": _int, + "long": long, + "readOnly": readOnly, + "short": short, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["char"]) -> MetaOapg.properties.char: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["direct"]) -> MetaOapg.properties.direct: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["double"]) -> MetaOapg.properties.double: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["float"]) -> MetaOapg.properties._float: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["int"]) -> MetaOapg.properties._int: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["long"]) -> MetaOapg.properties.long: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["readOnly"]) -> MetaOapg.properties.readOnly: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["short"]) -> MetaOapg.properties.short: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["char", "direct", "double", "float", "int", "long", "readOnly", "short", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["char"]) -> typing.Union[MetaOapg.properties.char, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["direct"]) -> typing.Union[MetaOapg.properties.direct, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["double"]) -> typing.Union[MetaOapg.properties.double, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["float"]) -> typing.Union[MetaOapg.properties._float, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["int"]) -> typing.Union[MetaOapg.properties._int, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["long"]) -> typing.Union[MetaOapg.properties.long, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["readOnly"]) -> typing.Union[MetaOapg.properties.readOnly, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["short"]) -> typing.Union[MetaOapg.properties.short, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["char", "direct", "double", "float", "int", "long", "readOnly", "short", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + char: typing.Union[MetaOapg.properties.char, str, schemas.Unset] = schemas.unset, + direct: typing.Union[MetaOapg.properties.direct, bool, schemas.Unset] = schemas.unset, + double: typing.Union[MetaOapg.properties.double, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + long: typing.Union[MetaOapg.properties.long, decimal.Decimal, int, schemas.Unset] = schemas.unset, + readOnly: typing.Union[MetaOapg.properties.readOnly, bool, schemas.Unset] = schemas.unset, + short: typing.Union[MetaOapg.properties.short, decimal.Decimal, int, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + char=char, + direct=direct, + double=double, + long=long, + readOnly=readOnly, + short=short, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor202ResponseBodyApplicationPdf': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class SchemaFor202ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + char = schemas.StrSchema + direct = schemas.BoolSchema + double = schemas.Float64Schema + _float = schemas.Float32Schema + _int = schemas.Int32Schema + long = schemas.Int64Schema + readOnly = schemas.BoolSchema + short = schemas.Int32Schema + __annotations__ = { + "char": char, + "direct": direct, + "double": double, + "float": _float, + "int": _int, + "long": long, + "readOnly": readOnly, + "short": short, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["char"]) -> MetaOapg.properties.char: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["direct"]) -> MetaOapg.properties.direct: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["double"]) -> MetaOapg.properties.double: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["float"]) -> MetaOapg.properties._float: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["int"]) -> MetaOapg.properties._int: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["long"]) -> MetaOapg.properties.long: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["readOnly"]) -> MetaOapg.properties.readOnly: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["short"]) -> MetaOapg.properties.short: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["char", "direct", "double", "float", "int", "long", "readOnly", "short", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["char"]) -> typing.Union[MetaOapg.properties.char, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["direct"]) -> typing.Union[MetaOapg.properties.direct, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["double"]) -> typing.Union[MetaOapg.properties.double, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["float"]) -> typing.Union[MetaOapg.properties._float, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["int"]) -> typing.Union[MetaOapg.properties._int, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["long"]) -> typing.Union[MetaOapg.properties.long, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["readOnly"]) -> typing.Union[MetaOapg.properties.readOnly, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["short"]) -> typing.Union[MetaOapg.properties.short, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["char", "direct", "double", "float", "int", "long", "readOnly", "short", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + char: typing.Union[MetaOapg.properties.char, str, schemas.Unset] = schemas.unset, + direct: typing.Union[MetaOapg.properties.direct, bool, schemas.Unset] = schemas.unset, + double: typing.Union[MetaOapg.properties.double, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + long: typing.Union[MetaOapg.properties.long, decimal.Decimal, int, schemas.Unset] = schemas.unset, + readOnly: typing.Union[MetaOapg.properties.readOnly, bool, schemas.Unset] = schemas.unset, + short: typing.Union[MetaOapg.properties.short, decimal.Decimal, int, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + char=char, + direct=direct, + double=double, + long=long, + readOnly=readOnly, + short=short, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor202ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor202(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor202ResponseBodyApplicationPdf, + SchemaFor202ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_202 = api_client.OpenApiResponse( + response_cls=ApiResponseFor202, + content={ + 'application/pdf': api_client.MediaType( + schema=SchemaFor202ResponseBodyApplicationPdf), + 'application/vnd.openxmlformats-officedocument.presentationml.presentation': api_client.MediaType( + schema=SchemaFor202ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation), + }, +) +_status_code_to_response = { + '200': _response_for_200, + '202': _response_for_202, +} +_all_accept_content_types = ( + 'application/pdf', + 'application/vnd.openxmlformats-officedocument.presentationml.presentation', + 'application/zip', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_slides_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def _get_slides_export_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_slides_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_slides_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Retrieve exported files + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_export_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetSlidesExport(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_slides_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def get_slides_export( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_slides_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_slides_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_slides_export_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_slides_export_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id/get.pyi new file mode 100644 index 000000000..7c8c6b1fb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id/get.pyi @@ -0,0 +1,623 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Path params +WorkspaceIdSchema = schemas.StrSchema +ExportIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'exportId': typing.Union[ExportIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_export_id = api_client.PathParameter( + name="exportId", + style=api_client.ParameterStyle.SIMPLE, + schema=ExportIdSchema, + required=True, +) + + +class ContentDispositionSchema( + schemas.StrSchema +): + pass +SchemaFor200ResponseBodyApplicationPdf = schemas.BinarySchema +SchemaFor200ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation = schemas.BinarySchema +SchemaFor200ResponseBodyApplicationZip = schemas.BinarySchema +ResponseHeadersFor200 = typing_extensions.TypedDict( + 'ResponseHeadersFor200', + { + 'Content-Disposition': ContentDispositionSchema, + } +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationPdf, + SchemaFor200ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation, + SchemaFor200ResponseBodyApplicationZip, + ] + headers: ResponseHeadersFor200 + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/pdf': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationPdf), + 'application/vnd.openxmlformats-officedocument.presentationml.presentation': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation), + 'application/zip': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationZip), + }, + headers=[ + content_disposition_parameter, + ] +) + + +class SchemaFor202ResponseBodyApplicationPdf( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + char = schemas.StrSchema + direct = schemas.BoolSchema + double = schemas.Float64Schema + _float = schemas.Float32Schema + _int = schemas.Int32Schema + long = schemas.Int64Schema + readOnly = schemas.BoolSchema + short = schemas.Int32Schema + __annotations__ = { + "char": char, + "direct": direct, + "double": double, + "float": _float, + "int": _int, + "long": long, + "readOnly": readOnly, + "short": short, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["char"]) -> MetaOapg.properties.char: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["direct"]) -> MetaOapg.properties.direct: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["double"]) -> MetaOapg.properties.double: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["float"]) -> MetaOapg.properties._float: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["int"]) -> MetaOapg.properties._int: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["long"]) -> MetaOapg.properties.long: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["readOnly"]) -> MetaOapg.properties.readOnly: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["short"]) -> MetaOapg.properties.short: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["char", "direct", "double", "float", "int", "long", "readOnly", "short", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["char"]) -> typing.Union[MetaOapg.properties.char, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["direct"]) -> typing.Union[MetaOapg.properties.direct, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["double"]) -> typing.Union[MetaOapg.properties.double, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["float"]) -> typing.Union[MetaOapg.properties._float, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["int"]) -> typing.Union[MetaOapg.properties._int, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["long"]) -> typing.Union[MetaOapg.properties.long, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["readOnly"]) -> typing.Union[MetaOapg.properties.readOnly, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["short"]) -> typing.Union[MetaOapg.properties.short, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["char", "direct", "double", "float", "int", "long", "readOnly", "short", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + char: typing.Union[MetaOapg.properties.char, str, schemas.Unset] = schemas.unset, + direct: typing.Union[MetaOapg.properties.direct, bool, schemas.Unset] = schemas.unset, + double: typing.Union[MetaOapg.properties.double, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + long: typing.Union[MetaOapg.properties.long, decimal.Decimal, int, schemas.Unset] = schemas.unset, + readOnly: typing.Union[MetaOapg.properties.readOnly, bool, schemas.Unset] = schemas.unset, + short: typing.Union[MetaOapg.properties.short, decimal.Decimal, int, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + char=char, + direct=direct, + double=double, + long=long, + readOnly=readOnly, + short=short, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor202ResponseBodyApplicationPdf': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class SchemaFor202ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.DictSchema + ): + + + class MetaOapg: + + class properties: + char = schemas.StrSchema + direct = schemas.BoolSchema + double = schemas.Float64Schema + _float = schemas.Float32Schema + _int = schemas.Int32Schema + long = schemas.Int64Schema + readOnly = schemas.BoolSchema + short = schemas.Int32Schema + __annotations__ = { + "char": char, + "direct": direct, + "double": double, + "float": _float, + "int": _int, + "long": long, + "readOnly": readOnly, + "short": short, + } + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["char"]) -> MetaOapg.properties.char: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["direct"]) -> MetaOapg.properties.direct: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["double"]) -> MetaOapg.properties.double: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["float"]) -> MetaOapg.properties._float: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["int"]) -> MetaOapg.properties._int: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["long"]) -> MetaOapg.properties.long: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["readOnly"]) -> MetaOapg.properties.readOnly: ... + + @typing.overload + def __getitem__(self, name: typing_extensions.Literal["short"]) -> MetaOapg.properties.short: ... + + @typing.overload + def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ... + + def __getitem__(self, name: typing.Union[typing_extensions.Literal["char", "direct", "double", "float", "int", "long", "readOnly", "short", ], str]): + # dict_instance[name] accessor + return super().__getitem__(name) + + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["char"]) -> typing.Union[MetaOapg.properties.char, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["direct"]) -> typing.Union[MetaOapg.properties.direct, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["double"]) -> typing.Union[MetaOapg.properties.double, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["float"]) -> typing.Union[MetaOapg.properties._float, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["int"]) -> typing.Union[MetaOapg.properties._int, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["long"]) -> typing.Union[MetaOapg.properties.long, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["readOnly"]) -> typing.Union[MetaOapg.properties.readOnly, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: typing_extensions.Literal["short"]) -> typing.Union[MetaOapg.properties.short, schemas.Unset]: ... + + @typing.overload + def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ... + + def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["char", "direct", "double", "float", "int", "long", "readOnly", "short", ], str]): + return super().get_item_oapg(name) + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, ], + char: typing.Union[MetaOapg.properties.char, str, schemas.Unset] = schemas.unset, + direct: typing.Union[MetaOapg.properties.direct, bool, schemas.Unset] = schemas.unset, + double: typing.Union[MetaOapg.properties.double, decimal.Decimal, int, float, schemas.Unset] = schemas.unset, + long: typing.Union[MetaOapg.properties.long, decimal.Decimal, int, schemas.Unset] = schemas.unset, + readOnly: typing.Union[MetaOapg.properties.readOnly, bool, schemas.Unset] = schemas.unset, + short: typing.Union[MetaOapg.properties.short, decimal.Decimal, int, schemas.Unset] = schemas.unset, + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'items': + return super().__new__( + cls, + *_args, + char=char, + direct=direct, + double=double, + long=long, + readOnly=readOnly, + short=short, + _configuration=_configuration, + **kwargs, + ) + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]], typing.List[typing.Union[MetaOapg.items, dict, frozendict.frozendict, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor202ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor202(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor202ResponseBodyApplicationPdf, + SchemaFor202ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_202 = api_client.OpenApiResponse( + response_cls=ApiResponseFor202, + content={ + 'application/pdf': api_client.MediaType( + schema=SchemaFor202ResponseBodyApplicationPdf), + 'application/vnd.openxmlformats-officedocument.presentationml.presentation': api_client.MediaType( + schema=SchemaFor202ResponseBodyApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation), + }, +) +_all_accept_content_types = ( + 'application/pdf', + 'application/vnd.openxmlformats-officedocument.presentationml.presentation', + 'application/zip', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_slides_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def _get_slides_export_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_slides_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_slides_export_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Retrieve exported files + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_export_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetSlidesExport(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_slides_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def get_slides_export( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_slides_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_slides_export( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_slides_export_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_slides_export_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id_metadata/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id_metadata/__init__.py new file mode 100644 index 000000000..c54b390c5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id_metadata/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_export_slides_export_id_metadata import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_EXPORT_SLIDES_EXPORT_ID_METADATA \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id_metadata/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id_metadata/get.py new file mode 100644 index 000000000..9282e62cd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id_metadata/get.py @@ -0,0 +1,298 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +ExportIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'exportId': typing.Union[ExportIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_export_id = api_client.PathParameter( + name="exportId", + style=api_client.ParameterStyle.SIMPLE, + schema=ExportIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + schemas.Unset, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType(), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_slides_export_metadata_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_slides_export_metadata_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_slides_export_metadata_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_slides_export_metadata_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Retrieve metadata context + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_export_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetSlidesExportMetadata(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_slides_export_metadata( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_slides_export_metadata( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_slides_export_metadata( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_slides_export_metadata( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_slides_export_metadata_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_slides_export_metadata_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id_metadata/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id_metadata/get.pyi new file mode 100644 index 000000000..ff461bbc6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_export_slides_export_id_metadata/get.pyi @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Path params +WorkspaceIdSchema = schemas.StrSchema +ExportIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'exportId': typing.Union[ExportIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_export_id = api_client.PathParameter( + name="exportId", + style=api_client.ParameterStyle.SIMPLE, + schema=ExportIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + schemas.Unset, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType(), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_slides_export_metadata_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_slides_export_metadata_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_slides_export_metadata_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_slides_export_metadata_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (EXPERIMENTAL) Retrieve metadata context + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_export_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetSlidesExportMetadata(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_slides_export_metadata( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_slides_export_metadata( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_slides_export_metadata( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_slides_export_metadata( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_slides_export_metadata_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_slides_export_metadata_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_prefixes/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_prefixes/__init__.py new file mode 100644 index 000000000..40b59900c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_prefixes/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_inherited_entity_prefixes import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_INHERITED_ENTITY_PREFIXES \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_prefixes/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_prefixes/get.py new file mode 100644 index 000000000..f36e0615e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_prefixes/get.py @@ -0,0 +1,313 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _inherited_entity_prefixes_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _inherited_entity_prefixes_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _inherited_entity_prefixes_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _inherited_entity_prefixes_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get used entity prefixes in hierarchy + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class InheritedEntityPrefixes(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def inherited_entity_prefixes( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def inherited_entity_prefixes( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def inherited_entity_prefixes( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def inherited_entity_prefixes( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._inherited_entity_prefixes_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._inherited_entity_prefixes_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_prefixes/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_prefixes/get.pyi new file mode 100644 index 000000000..44c29a7cc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_inherited_entity_prefixes/get.pyi @@ -0,0 +1,308 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _inherited_entity_prefixes_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _inherited_entity_prefixes_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _inherited_entity_prefixes_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _inherited_entity_prefixes_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get used entity prefixes in hierarchy + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class InheritedEntityPrefixes(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def inherited_entity_prefixes( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def inherited_entity_prefixes( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def inherited_entity_prefixes( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def inherited_entity_prefixes( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._inherited_entity_prefixes_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._inherited_entity_prefixes_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_manage_permissions/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_manage_permissions/__init__.py new file mode 100644 index 000000000..6f2134955 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_manage_permissions/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_manage_permissions import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_MANAGE_PERMISSIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_manage_permissions/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_manage_permissions/post.py new file mode 100644 index 000000000..91e2639b7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_manage_permissions/post.py @@ -0,0 +1,385 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.workspace_permission_assignment import WorkspacePermissionAssignment + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param + + +class SchemaForRequestBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['WorkspacePermissionAssignment']: + return WorkspacePermissionAssignment + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['WorkspacePermissionAssignment'], typing.List['WorkspacePermissionAssignment']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaForRequestBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'WorkspacePermissionAssignment': + return super().__getitem__(i) + + +request_body_workspace_permission_assignment = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _manage_workspace_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _manage_workspace_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _manage_workspace_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _manage_workspace_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _manage_workspace_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Manage Permissions for a Workspace + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_workspace_permission_assignment.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ManageWorkspacePermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def manage_workspace_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def manage_workspace_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def manage_workspace_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def manage_workspace_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def manage_workspace_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_workspace_permissions_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_workspace_permissions_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_manage_permissions/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_manage_permissions/post.pyi new file mode 100644 index 000000000..c3e71b0dc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_manage_permissions/post.pyi @@ -0,0 +1,380 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.workspace_permission_assignment import WorkspacePermissionAssignment + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param + + +class SchemaForRequestBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['WorkspacePermissionAssignment']: + return WorkspacePermissionAssignment + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['WorkspacePermissionAssignment'], typing.List['WorkspacePermissionAssignment']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaForRequestBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'WorkspacePermissionAssignment': + return super().__getitem__(i) + + +request_body_workspace_permission_assignment = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _manage_workspace_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _manage_workspace_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _manage_workspace_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _manage_workspace_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _manage_workspace_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Manage Permissions for a Workspace + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_workspace_permission_assignment.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ManageWorkspacePermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def manage_workspace_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def manage_workspace_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def manage_workspace_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def manage_workspace_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def manage_workspace_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_workspace_permissions_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._manage_workspace_permissions_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_metadata_sync/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_metadata_sync/__init__.py new file mode 100644 index 000000000..e5bd6fdf0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_metadata_sync/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_metadata_sync import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_METADATA_SYNC \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_metadata_sync/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_metadata_sync/post.py new file mode 100644 index 000000000..879ecf448 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_metadata_sync/post.py @@ -0,0 +1,260 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, +) +_status_code_to_response = { + '200': _response_for_200, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _metadata_sync_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _metadata_sync_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _metadata_sync_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _metadata_sync_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Sync Metadata to other services + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class MetadataSync(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def metadata_sync( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def metadata_sync( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def metadata_sync( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def metadata_sync( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._metadata_sync_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._metadata_sync_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_metadata_sync/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_metadata_sync/post.pyi new file mode 100644 index 000000000..e9d39288a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_metadata_sync/post.pyi @@ -0,0 +1,255 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _metadata_sync_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _metadata_sync_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _metadata_sync_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _metadata_sync_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Sync Metadata to other services + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class MetadataSync(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def metadata_sync( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def metadata_sync( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def metadata_sync( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def metadata_sync( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._metadata_sync_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._metadata_sync_oapg( + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_set_certification/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_set_certification/__init__.py new file mode 100644 index 000000000..3b139c695 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_set_certification/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_set_certification import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_SET_CERTIFICATION \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_set_certification/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_set_certification/post.py new file mode 100644 index 000000000..0a1383a16 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_set_certification/post.py @@ -0,0 +1,360 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.set_certification_request import SetCertificationRequest + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = SetCertificationRequest + + +request_body_set_certification_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _set_certification_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_certification_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_certification_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_certification_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_certification_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set Certification + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_set_certification_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetCertification(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_certification( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_certification( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_certification( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_certification( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_certification( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_certification_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_certification_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_set_certification/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_set_certification/post.pyi new file mode 100644 index 000000000..801d42adf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_set_certification/post.pyi @@ -0,0 +1,355 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.set_certification_request import SetCertificationRequest + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = SetCertificationRequest + + +request_body_set_certification_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _set_certification_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_certification_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_certification_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_certification_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_certification_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set Certification + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_set_certification_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetCertification(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_certification( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_certification( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_certification( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_certification( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_certification( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_certification_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_certification_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations/__init__.py new file mode 100644 index 000000000..9e014e857 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_translations import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_TRANSLATIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations/get.py new file mode 100644 index 000000000..6a5372228 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations/get.py @@ -0,0 +1,313 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_translation_tags_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_translation_tags_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_translation_tags_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_translation_tags_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get translation tags. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetTranslationTags(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_translation_tags( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_translation_tags( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_translation_tags( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_translation_tags( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_translation_tags_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_translation_tags_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations/get.pyi new file mode 100644 index 000000000..b59ea78a9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations/get.pyi @@ -0,0 +1,308 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_translation_tags_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_translation_tags_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_translation_tags_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_translation_tags_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get translation tags. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetTranslationTags(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_translation_tags( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_translation_tags( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_translation_tags( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_translation_tags( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_translation_tags_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_translation_tags_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_clean/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_clean/__init__.py new file mode 100644 index 000000000..add587715 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_clean/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_translations_clean import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_TRANSLATIONS_CLEAN \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_clean/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_clean/post.py new file mode 100644 index 000000000..920741ffc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_clean/post.py @@ -0,0 +1,360 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.locale_request import LocaleRequest + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = LocaleRequest + + +request_body_locale_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _clean_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _clean_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _clean_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _clean_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _clean_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Cleans up translations. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_locale_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CleanTranslations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def clean_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def clean_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def clean_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def clean_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def clean_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._clean_translations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._clean_translations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_clean/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_clean/post.pyi new file mode 100644 index 000000000..d8fb234ed --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_clean/post.pyi @@ -0,0 +1,355 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.locale_request import LocaleRequest + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = LocaleRequest + + +request_body_locale_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _clean_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _clean_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _clean_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _clean_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _clean_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Cleans up translations. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_locale_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CleanTranslations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def clean_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def clean_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def clean_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def clean_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def clean_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._clean_translations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._clean_translations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_retrieve/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_retrieve/__init__.py new file mode 100644 index 000000000..9b87d864f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_retrieve/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_translations_retrieve import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_TRANSLATIONS_RETRIEVE \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_retrieve/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_retrieve/post.py new file mode 100644 index 000000000..24efd6c52 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_retrieve/post.py @@ -0,0 +1,391 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.locale_request import LocaleRequest +from gooddata_api_client.model.xliff import Xliff + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = LocaleRequest + + +request_body_locale_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationXml = Xliff + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationXml, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/xml': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationXml), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/xml', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _retrieve_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _retrieve_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _retrieve_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _retrieve_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _retrieve_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve translations for entities. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_locale_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class RetrieveTranslations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def retrieve_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def retrieve_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def retrieve_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def retrieve_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def retrieve_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._retrieve_translations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._retrieve_translations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_retrieve/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_retrieve/post.pyi new file mode 100644 index 000000000..5c5250bf8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_retrieve/post.pyi @@ -0,0 +1,386 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.locale_request import LocaleRequest +from gooddata_api_client.model.xliff import Xliff + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = LocaleRequest + + +request_body_locale_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationXml = Xliff + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationXml, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/xml': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationXml), + }, +) +_all_accept_content_types = ( + 'application/xml', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _retrieve_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _retrieve_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _retrieve_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _retrieve_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _retrieve_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Retrieve translations for entities. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_locale_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class RetrieveTranslations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def retrieve_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def retrieve_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def retrieve_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def retrieve_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def retrieve_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._retrieve_translations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._retrieve_translations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_set/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_set/__init__.py new file mode 100644 index 000000000..fce5c7124 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_set/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_translations_set import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_TRANSLATIONS_SET \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_set/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_set/post.py new file mode 100644 index 000000000..43c405ba3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_set/post.py @@ -0,0 +1,360 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.xliff import Xliff + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationXml = Xliff + + +request_body_xliff = api_client.RequestBody( + content={ + 'application/xml': api_client.MediaType( + schema=SchemaForRequestBodyApplicationXml), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _set_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: typing_extensions.Literal["application/xml"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = 'application/xml', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set translations for entities. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_xliff.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetTranslations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: typing_extensions.Literal["application/xml"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = 'application/xml', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_translations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: typing_extensions.Literal["application/xml"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = 'application/xml', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_translations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_set/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_set/post.pyi new file mode 100644 index 000000000..1a93daa00 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_translations_set/post.pyi @@ -0,0 +1,355 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.xliff import Xliff + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationXml = Xliff + + +request_body_xliff = api_client.RequestBody( + content={ + 'application/xml': api_client.MediaType( + schema=SchemaForRequestBodyApplicationXml), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _set_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: typing_extensions.Literal["application/xml"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_translations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = 'application/xml', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set translations for entities. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_xliff.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetTranslations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: typing_extensions.Literal["application/xml"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_translations( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = 'application/xml', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_translations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: typing_extensions.Literal["application/xml"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationXml,], + content_type: str = 'application/xml', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_translations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_user_groups/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_user_groups/__init__.py new file mode 100644 index 000000000..aa2ec808f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_user_groups/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_user_groups import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_USER_GROUPS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_user_groups/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_user_groups/get.py new file mode 100644 index 000000000..dee180f1c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_user_groups/get.py @@ -0,0 +1,364 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.workspace_user_groups import WorkspaceUserGroups + +from . import path + +# Query params +PageSchema = schemas.Int32Schema +SizeSchema = schemas.Int32Schema +NameSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'name': typing.Union[NameSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_name = api_client.QueryParameter( + name="name", + style=api_client.ParameterStyle.FORM, + schema=NameSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = WorkspaceUserGroups + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_workspace_user_groups_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_workspace_user_groups_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_workspace_user_groups_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_workspace_user_groups_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_page, + request_query_size, + request_query_name, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListWorkspaceUserGroups(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_workspace_user_groups( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_workspace_user_groups( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_workspace_user_groups( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_workspace_user_groups( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_workspace_user_groups_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_workspace_user_groups_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_user_groups/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_user_groups/get.pyi new file mode 100644 index 000000000..2f9cf74ee --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_user_groups/get.pyi @@ -0,0 +1,359 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.workspace_user_groups import WorkspaceUserGroups + +# Query params +PageSchema = schemas.Int32Schema +SizeSchema = schemas.Int32Schema +NameSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'name': typing.Union[NameSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_name = api_client.QueryParameter( + name="name", + style=api_client.ParameterStyle.FORM, + schema=NameSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = WorkspaceUserGroups + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_workspace_user_groups_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_workspace_user_groups_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_workspace_user_groups_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_workspace_user_groups_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_page, + request_query_size, + request_query_name, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListWorkspaceUserGroups(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_workspace_user_groups( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_workspace_user_groups( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_workspace_user_groups( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_workspace_user_groups( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_workspace_user_groups_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_workspace_user_groups_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_users/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_users/__init__.py new file mode 100644 index 000000000..8a039be40 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_users/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_actions_workspaces_workspace_id_users import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ACTIONS_WORKSPACES_WORKSPACE_ID_USERS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_users/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_users/get.py new file mode 100644 index 000000000..9766a87fb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_users/get.py @@ -0,0 +1,364 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.workspace_users import WorkspaceUsers + +from . import path + +# Query params +PageSchema = schemas.Int32Schema +SizeSchema = schemas.Int32Schema +NameSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'name': typing.Union[NameSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_name = api_client.QueryParameter( + name="name", + style=api_client.ParameterStyle.FORM, + schema=NameSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = WorkspaceUsers + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_workspace_users_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_workspace_users_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_workspace_users_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_workspace_users_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_page, + request_query_size, + request_query_name, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListWorkspaceUsers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_workspace_users( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_workspace_users( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_workspace_users( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_workspace_users( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_workspace_users_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_workspace_users_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_users/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_users/get.pyi new file mode 100644 index 000000000..5d6fc70c6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_actions_workspaces_workspace_id_users/get.pyi @@ -0,0 +1,359 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.workspace_users import WorkspaceUsers + +# Query params +PageSchema = schemas.Int32Schema +SizeSchema = schemas.Int32Schema +NameSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'name': typing.Union[NameSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_name = api_client.QueryParameter( + name="name", + style=api_client.ParameterStyle.FORM, + schema=NameSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = WorkspaceUsers + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_workspace_users_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_workspace_users_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_workspace_users_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_workspace_users_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_page, + request_query_size, + request_query_name, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListWorkspaceUsers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_workspace_users( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_workspace_users( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_workspace_users( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_workspace_users( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_workspace_users_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_workspace_users_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances/__init__.py new file mode 100644 index 000000000..6f074758a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_ailake_database_instances import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_AILAKE_DATABASE_INSTANCES \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances/get.py new file mode 100644 index 000000000..0013cec10 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances/get.py @@ -0,0 +1,264 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.database_instance import DatabaseInstance + +from . import path + + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DatabaseInstance']: + return DatabaseInstance + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DatabaseInstance'], typing.List['DatabaseInstance']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DatabaseInstance': + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_ai_lake_database_instances_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_ai_lake_database_instances_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_ai_lake_database_instances_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_ai_lake_database_instances_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) List AI Lake Database instances + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListAiLakeDatabaseInstances(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_ai_lake_database_instances( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_ai_lake_database_instances( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_ai_lake_database_instances( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_ai_lake_database_instances( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_ai_lake_database_instances_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_ai_lake_database_instances_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances/get.pyi new file mode 100644 index 000000000..42edeb17f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances/get.pyi @@ -0,0 +1,259 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.database_instance import DatabaseInstance + + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DatabaseInstance']: + return DatabaseInstance + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DatabaseInstance'], typing.List['DatabaseInstance']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DatabaseInstance': + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_ai_lake_database_instances_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_ai_lake_database_instances_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_ai_lake_database_instances_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_ai_lake_database_instances_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) List AI Lake Database instances + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListAiLakeDatabaseInstances(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_ai_lake_database_instances( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_ai_lake_database_instances( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_ai_lake_database_instances( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_ai_lake_database_instances( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_ai_lake_database_instances_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_ai_lake_database_instances_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances/post.py new file mode 100644 index 000000000..416229c5f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances/post.py @@ -0,0 +1,409 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.provision_database_instance_request import ProvisionDatabaseInstanceRequest + +from . import path + +# Header params +OperationIdSchema = schemas.StrSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'operation-id': typing.Union[OperationIdSchema, str, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_operation_id = api_client.HeaderParameter( + name="operation-id", + style=api_client.ParameterStyle.SIMPLE, + schema=OperationIdSchema, +) +# body param +SchemaForRequestBodyApplicationJson = ProvisionDatabaseInstanceRequest + + +request_body_provision_database_instance_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +OperationIdSchema = schemas.StrSchema +operation_id_parameter = api_client.HeaderParameter( + name="operation-id", + style=api_client.ParameterStyle.SIMPLE, + schema=OperationIdSchema, + required=True, +) +OperationLocationSchema = schemas.StrSchema +operation_location_parameter = api_client.HeaderParameter( + name="operation-location", + style=api_client.ParameterStyle.SIMPLE, + schema=OperationLocationSchema, + required=True, +) +SchemaFor202ResponseBodyApplicationJson = schemas.DictSchema +ResponseHeadersFor202 = typing_extensions.TypedDict( + 'ResponseHeadersFor202', + { + 'operation-id': OperationIdSchema, + 'operation-location': OperationLocationSchema, + } +) + + +@dataclass +class ApiResponseFor202(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor202ResponseBodyApplicationJson, + ] + headers: ResponseHeadersFor202 + + +_response_for_202 = api_client.OpenApiResponse( + response_cls=ApiResponseFor202, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor202ResponseBodyApplicationJson), + }, + headers=[ + operation_id_parameter, + operation_location_parameter, + ] +) +_status_code_to_response = { + '202': _response_for_202, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _provision_ai_lake_database_instance_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def _provision_ai_lake_database_instance_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + + @typing.overload + def _provision_ai_lake_database_instance_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _provision_ai_lake_database_instance_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _provision_ai_lake_database_instance_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Create a new AILake Database instance + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + used_path = path.value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_operation_id, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_provision_database_instance_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ProvisionAiLakeDatabaseInstance(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def provision_ai_lake_database_instance( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def provision_ai_lake_database_instance( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + + @typing.overload + def provision_ai_lake_database_instance( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def provision_ai_lake_database_instance( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def provision_ai_lake_database_instance( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._provision_ai_lake_database_instance_oapg( + body=body, + header_params=header_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._provision_ai_lake_database_instance_oapg( + body=body, + header_params=header_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances/post.pyi new file mode 100644 index 000000000..9b2fb82ee --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances/post.pyi @@ -0,0 +1,392 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.provision_database_instance_request import ProvisionDatabaseInstanceRequest + +# Header params +OperationIdSchema = schemas.StrSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'operation-id': typing.Union[OperationIdSchema, str, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_operation_id = api_client.HeaderParameter( + name="operation-id", + style=api_client.ParameterStyle.SIMPLE, + schema=OperationIdSchema, +) +# body param +SchemaForRequestBodyApplicationJson = ProvisionDatabaseInstanceRequest + + +request_body_provision_database_instance_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +OperationIdSchema = schemas.StrSchema +OperationLocationSchema = schemas.StrSchema +SchemaFor202ResponseBodyApplicationJson = schemas.DictSchema +ResponseHeadersFor202 = typing_extensions.TypedDict( + 'ResponseHeadersFor202', + { + 'operation-id': OperationIdSchema, + 'operation-location': OperationLocationSchema, + } +) + + +@dataclass +class ApiResponseFor202(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor202ResponseBodyApplicationJson, + ] + headers: ResponseHeadersFor202 + + +_response_for_202 = api_client.OpenApiResponse( + response_cls=ApiResponseFor202, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor202ResponseBodyApplicationJson), + }, + headers=[ + operation_id_parameter, + operation_location_parameter, + ] +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _provision_ai_lake_database_instance_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def _provision_ai_lake_database_instance_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + + @typing.overload + def _provision_ai_lake_database_instance_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _provision_ai_lake_database_instance_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _provision_ai_lake_database_instance_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Create a new AILake Database instance + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + used_path = path.value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_operation_id, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_provision_database_instance_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ProvisionAiLakeDatabaseInstance(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def provision_ai_lake_database_instance( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def provision_ai_lake_database_instance( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + + @typing.overload + def provision_ai_lake_database_instance( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def provision_ai_lake_database_instance( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def provision_ai_lake_database_instance( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._provision_ai_lake_database_instance_oapg( + body=body, + header_params=header_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._provision_ai_lake_database_instance_oapg( + body=body, + header_params=header_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances_instance_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances_instance_id/__init__.py new file mode 100644 index 000000000..1056a7a1b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances_instance_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_ailake_database_instances_instance_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_AILAKE_DATABASE_INSTANCES_INSTANCE_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances_instance_id/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances_instance_id/delete.py new file mode 100644 index 000000000..f77178375 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances_instance_id/delete.py @@ -0,0 +1,364 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Header params +OperationIdSchema = schemas.StrSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'operation-id': typing.Union[OperationIdSchema, str, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_operation_id = api_client.HeaderParameter( + name="operation-id", + style=api_client.ParameterStyle.SIMPLE, + schema=OperationIdSchema, +) +# Path params +InstanceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'instanceId': typing.Union[InstanceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_instance_id = api_client.PathParameter( + name="instanceId", + style=api_client.ParameterStyle.SIMPLE, + schema=InstanceIdSchema, + required=True, +) +OperationIdSchema = schemas.StrSchema +operation_id_parameter = api_client.HeaderParameter( + name="operation-id", + style=api_client.ParameterStyle.SIMPLE, + schema=OperationIdSchema, + required=True, +) +OperationLocationSchema = schemas.StrSchema +operation_location_parameter = api_client.HeaderParameter( + name="operation-location", + style=api_client.ParameterStyle.SIMPLE, + schema=OperationLocationSchema, + required=True, +) +SchemaFor202ResponseBodyApplicationJson = schemas.DictSchema +ResponseHeadersFor202 = typing_extensions.TypedDict( + 'ResponseHeadersFor202', + { + 'operation-id': OperationIdSchema, + 'operation-location': OperationLocationSchema, + } +) + + +@dataclass +class ApiResponseFor202(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor202ResponseBodyApplicationJson, + ] + headers: ResponseHeadersFor202 + + +_response_for_202 = api_client.OpenApiResponse( + response_cls=ApiResponseFor202, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor202ResponseBodyApplicationJson), + }, + headers=[ + operation_id_parameter, + operation_location_parameter, + ] +) +_status_code_to_response = { + '202': _response_for_202, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _deprovision_ai_lake_database_instance_oapg( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def _deprovision_ai_lake_database_instance_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _deprovision_ai_lake_database_instance_oapg( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _deprovision_ai_lake_database_instance_oapg( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Delete an existing AILake Database instance + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_instance_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_operation_id, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeprovisionAiLakeDatabaseInstance(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def deprovision_ai_lake_database_instance( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def deprovision_ai_lake_database_instance( + self, + skip_deserialization: typing_extensions.Literal[True], + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def deprovision_ai_lake_database_instance( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def deprovision_ai_lake_database_instance( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._deprovision_ai_lake_database_instance_oapg( + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._deprovision_ai_lake_database_instance_oapg( + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances_instance_id/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances_instance_id/delete.pyi new file mode 100644 index 000000000..473333fbe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances_instance_id/delete.pyi @@ -0,0 +1,347 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Header params +OperationIdSchema = schemas.StrSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'operation-id': typing.Union[OperationIdSchema, str, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_operation_id = api_client.HeaderParameter( + name="operation-id", + style=api_client.ParameterStyle.SIMPLE, + schema=OperationIdSchema, +) +# Path params +InstanceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'instanceId': typing.Union[InstanceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_instance_id = api_client.PathParameter( + name="instanceId", + style=api_client.ParameterStyle.SIMPLE, + schema=InstanceIdSchema, + required=True, +) +OperationIdSchema = schemas.StrSchema +OperationLocationSchema = schemas.StrSchema +SchemaFor202ResponseBodyApplicationJson = schemas.DictSchema +ResponseHeadersFor202 = typing_extensions.TypedDict( + 'ResponseHeadersFor202', + { + 'operation-id': OperationIdSchema, + 'operation-location': OperationLocationSchema, + } +) + + +@dataclass +class ApiResponseFor202(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor202ResponseBodyApplicationJson, + ] + headers: ResponseHeadersFor202 + + +_response_for_202 = api_client.OpenApiResponse( + response_cls=ApiResponseFor202, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor202ResponseBodyApplicationJson), + }, + headers=[ + operation_id_parameter, + operation_location_parameter, + ] +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _deprovision_ai_lake_database_instance_oapg( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def _deprovision_ai_lake_database_instance_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _deprovision_ai_lake_database_instance_oapg( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _deprovision_ai_lake_database_instance_oapg( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Delete an existing AILake Database instance + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_instance_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_operation_id, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeprovisionAiLakeDatabaseInstance(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def deprovision_ai_lake_database_instance( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def deprovision_ai_lake_database_instance( + self, + skip_deserialization: typing_extensions.Literal[True], + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def deprovision_ai_lake_database_instance( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def deprovision_ai_lake_database_instance( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._deprovision_ai_lake_database_instance_oapg( + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._deprovision_ai_lake_database_instance_oapg( + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances_instance_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances_instance_id/get.py new file mode 100644 index 000000000..f60fa7f6b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances_instance_id/get.py @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.database_instance import DatabaseInstance + +from . import path + +# Path params +InstanceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'instanceId': typing.Union[InstanceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_instance_id = api_client.PathParameter( + name="instanceId", + style=api_client.ParameterStyle.SIMPLE, + schema=InstanceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = DatabaseInstance + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_ai_lake_database_instance_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_ai_lake_database_instance_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_ai_lake_database_instance_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_ai_lake_database_instance_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Get the specified AILake Database instance + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_instance_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAiLakeDatabaseInstance(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_ai_lake_database_instance( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_ai_lake_database_instance( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_ai_lake_database_instance( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_ai_lake_database_instance( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_ai_lake_database_instance_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_ai_lake_database_instance_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances_instance_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances_instance_id/get.pyi new file mode 100644 index 000000000..d6139738c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_database_instances_instance_id/get.pyi @@ -0,0 +1,288 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.database_instance import DatabaseInstance + +# Path params +InstanceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'instanceId': typing.Union[InstanceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_instance_id = api_client.PathParameter( + name="instanceId", + style=api_client.ParameterStyle.SIMPLE, + schema=InstanceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = DatabaseInstance + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_ai_lake_database_instance_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_ai_lake_database_instance_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_ai_lake_database_instance_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_ai_lake_database_instance_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Get the specified AILake Database instance + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_instance_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAiLakeDatabaseInstance(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_ai_lake_database_instance( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_ai_lake_database_instance( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_ai_lake_database_instance( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_ai_lake_database_instance( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_ai_lake_database_instance_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_ai_lake_database_instance_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_operations_operation_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_operations_operation_id/__init__.py new file mode 100644 index 000000000..d84fa5ea3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_operations_operation_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_ailake_operations_operation_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_AILAKE_OPERATIONS_OPERATION_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_operations_operation_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_operations_operation_id/get.py new file mode 100644 index 000000000..be9e1bf6d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_operations_operation_id/get.py @@ -0,0 +1,332 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.failed_operation import FailedOperation +from gooddata_api_client.model.pending_operation import PendingOperation +from gooddata_api_client.model.succeeded_operation import SucceededOperation + +from . import path + +# Path params +OperationIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'operationId': typing.Union[OperationIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_operation_id = api_client.PathParameter( + name="operationId", + style=api_client.ParameterStyle.SIMPLE, + schema=OperationIdSchema, + required=True, +) + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ComposedSchema, +): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + FailedOperation, + PendingOperation, + SucceededOperation, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_ai_lake_operation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_ai_lake_operation_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_ai_lake_operation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_ai_lake_operation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Get Long Running Operation details + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_operation_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAiLakeOperation(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_ai_lake_operation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_ai_lake_operation( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_ai_lake_operation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_ai_lake_operation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_ai_lake_operation_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_ai_lake_operation_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_operations_operation_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_operations_operation_id/get.pyi new file mode 100644 index 000000000..f927b5057 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_operations_operation_id/get.pyi @@ -0,0 +1,327 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.failed_operation import FailedOperation +from gooddata_api_client.model.pending_operation import PendingOperation +from gooddata_api_client.model.succeeded_operation import SucceededOperation + +# Path params +OperationIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'operationId': typing.Union[OperationIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_operation_id = api_client.PathParameter( + name="operationId", + style=api_client.ParameterStyle.SIMPLE, + schema=OperationIdSchema, + required=True, +) + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ComposedSchema, +): + + + class MetaOapg: + + @classmethod + @functools.lru_cache() + def one_of(cls): + # 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 + return [ + FailedOperation, + PendingOperation, + SucceededOperation, + ] + + + def __new__( + cls, + *_args: typing.Union[dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ], + _configuration: typing.Optional[schemas.Configuration] = None, + **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes], + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + *_args, + _configuration=_configuration, + **kwargs, + ) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_ai_lake_operation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_ai_lake_operation_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_ai_lake_operation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_ai_lake_operation_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Get Long Running Operation details + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_operation_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAiLakeOperation(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_ai_lake_operation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_ai_lake_operation( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_ai_lake_operation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_ai_lake_operation( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_ai_lake_operation_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_ai_lake_operation_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services/__init__.py new file mode 100644 index 000000000..5b2f35870 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_ailake_services import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_AILAKE_SERVICES \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services/get.py new file mode 100644 index 000000000..52693c125 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services/get.py @@ -0,0 +1,264 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.service_info import ServiceInfo + +from . import path + + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ServiceInfo']: + return ServiceInfo + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['ServiceInfo'], typing.List['ServiceInfo']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ServiceInfo': + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_ai_lake_services_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_ai_lake_services_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_ai_lake_services_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_ai_lake_services_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) List AI Lake services + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListAiLakeServices(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_ai_lake_services( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_ai_lake_services( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_ai_lake_services( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_ai_lake_services( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_ai_lake_services_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_ai_lake_services_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services/get.pyi new file mode 100644 index 000000000..b33308640 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services/get.pyi @@ -0,0 +1,259 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.service_info import ServiceInfo + + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['ServiceInfo']: + return ServiceInfo + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['ServiceInfo'], typing.List['ServiceInfo']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'ServiceInfo': + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _list_ai_lake_services_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _list_ai_lake_services_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _list_ai_lake_services_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _list_ai_lake_services_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) List AI Lake services + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class ListAiLakeServices(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def list_ai_lake_services( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def list_ai_lake_services( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def list_ai_lake_services( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def list_ai_lake_services( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_ai_lake_services_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._list_ai_lake_services_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services_service_id_commands_command_name_run/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services_service_id_commands_command_name_run/__init__.py new file mode 100644 index 000000000..99bf11f8c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services_service_id_commands_command_name_run/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_ailake_services_service_id_commands_command_name_run import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_AILAKE_SERVICES_SERVICE_ID_COMMANDS_COMMAND_NAME_RUN \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services_service_id_commands_command_name_run/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services_service_id_commands_command_name_run/post.py new file mode 100644 index 000000000..31ff4edaa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services_service_id_commands_command_name_run/post.py @@ -0,0 +1,475 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.run_service_command_request import RunServiceCommandRequest + +from . import path + +# Header params +OperationIdSchema = schemas.StrSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'operation-id': typing.Union[OperationIdSchema, str, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_operation_id = api_client.HeaderParameter( + name="operation-id", + style=api_client.ParameterStyle.SIMPLE, + schema=OperationIdSchema, +) +# Path params +ServiceIdSchema = schemas.StrSchema +CommandNameSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'serviceId': typing.Union[ServiceIdSchema, str, ], + 'commandName': typing.Union[CommandNameSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_service_id = api_client.PathParameter( + name="serviceId", + style=api_client.ParameterStyle.SIMPLE, + schema=ServiceIdSchema, + required=True, +) +request_path_command_name = api_client.PathParameter( + name="commandName", + style=api_client.ParameterStyle.SIMPLE, + schema=CommandNameSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = RunServiceCommandRequest + + +request_body_run_service_command_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +OperationIdSchema = schemas.StrSchema +operation_id_parameter = api_client.HeaderParameter( + name="operation-id", + style=api_client.ParameterStyle.SIMPLE, + schema=OperationIdSchema, + required=True, +) +OperationLocationSchema = schemas.StrSchema +operation_location_parameter = api_client.HeaderParameter( + name="operation-location", + style=api_client.ParameterStyle.SIMPLE, + schema=OperationLocationSchema, + required=True, +) +SchemaFor202ResponseBodyApplicationJson = schemas.DictSchema +ResponseHeadersFor202 = typing_extensions.TypedDict( + 'ResponseHeadersFor202', + { + 'operation-id': OperationIdSchema, + 'operation-location': OperationLocationSchema, + } +) + + +@dataclass +class ApiResponseFor202(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor202ResponseBodyApplicationJson, + ] + headers: ResponseHeadersFor202 + + +_response_for_202 = api_client.OpenApiResponse( + response_cls=ApiResponseFor202, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor202ResponseBodyApplicationJson), + }, + headers=[ + operation_id_parameter, + operation_location_parameter, + ] +) +_status_code_to_response = { + '202': _response_for_202, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _run_ai_lake_service_command_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def _run_ai_lake_service_command_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + + @typing.overload + def _run_ai_lake_service_command_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _run_ai_lake_service_command_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _run_ai_lake_service_command_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Run an AI Lake services command + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_service_id, + request_path_command_name, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_operation_id, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_run_service_command_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class RunAiLakeServiceCommand(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def run_ai_lake_service_command( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def run_ai_lake_service_command( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + + @typing.overload + def run_ai_lake_service_command( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def run_ai_lake_service_command( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def run_ai_lake_service_command( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._run_ai_lake_service_command_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._run_ai_lake_service_command_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services_service_id_commands_command_name_run/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services_service_id_commands_command_name_run/post.pyi new file mode 100644 index 000000000..9ee1b0239 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_ailake_services_service_id_commands_command_name_run/post.pyi @@ -0,0 +1,458 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.run_service_command_request import RunServiceCommandRequest + +# Header params +OperationIdSchema = schemas.StrSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'operation-id': typing.Union[OperationIdSchema, str, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_operation_id = api_client.HeaderParameter( + name="operation-id", + style=api_client.ParameterStyle.SIMPLE, + schema=OperationIdSchema, +) +# Path params +ServiceIdSchema = schemas.StrSchema +CommandNameSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'serviceId': typing.Union[ServiceIdSchema, str, ], + 'commandName': typing.Union[CommandNameSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_service_id = api_client.PathParameter( + name="serviceId", + style=api_client.ParameterStyle.SIMPLE, + schema=ServiceIdSchema, + required=True, +) +request_path_command_name = api_client.PathParameter( + name="commandName", + style=api_client.ParameterStyle.SIMPLE, + schema=CommandNameSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = RunServiceCommandRequest + + +request_body_run_service_command_request = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +OperationIdSchema = schemas.StrSchema +OperationLocationSchema = schemas.StrSchema +SchemaFor202ResponseBodyApplicationJson = schemas.DictSchema +ResponseHeadersFor202 = typing_extensions.TypedDict( + 'ResponseHeadersFor202', + { + 'operation-id': OperationIdSchema, + 'operation-location': OperationLocationSchema, + } +) + + +@dataclass +class ApiResponseFor202(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor202ResponseBodyApplicationJson, + ] + headers: ResponseHeadersFor202 + + +_response_for_202 = api_client.OpenApiResponse( + response_cls=ApiResponseFor202, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor202ResponseBodyApplicationJson), + }, + headers=[ + operation_id_parameter, + operation_location_parameter, + ] +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _run_ai_lake_service_command_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def _run_ai_lake_service_command_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + + @typing.overload + def _run_ai_lake_service_command_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _run_ai_lake_service_command_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _run_ai_lake_service_command_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + (BETA) Run an AI Lake services command + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_service_id, + request_path_command_name, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_operation_id, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_run_service_command_request.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class RunAiLakeServiceCommand(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def run_ai_lake_service_command( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def run_ai_lake_service_command( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + + @typing.overload + def run_ai_lake_service_command( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def run_ai_lake_service_command( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def run_ai_lake_service_command( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._run_ai_lake_service_command_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor202, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor202, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._run_ai_lake_service_command_oapg( + body=body, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections/__init__.py new file mode 100644 index 000000000..63e1b5c68 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_custom_geo_collections import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_CUSTOM_GEO_COLLECTIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections/get.py new file mode 100644 index 000000000..4aa7db67c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections/get.py @@ -0,0 +1,402 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_custom_geo_collection_out_list import JsonApiCustomGeoCollectionOutList + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiCustomGeoCollectionOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiCustomGeoCollectionOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_custom_geo_collections_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesCustomGeoCollections(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_custom_geo_collections( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_custom_geo_collections_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_custom_geo_collections_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections/get.pyi new file mode 100644 index 000000000..a72762bcd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections/get.pyi @@ -0,0 +1,388 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_custom_geo_collection_out_list import JsonApiCustomGeoCollectionOutList + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiCustomGeoCollectionOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiCustomGeoCollectionOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_custom_geo_collections_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesCustomGeoCollections(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_custom_geo_collections( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_custom_geo_collections_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_custom_geo_collections_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections/post.py new file mode 100644 index 000000000..8a05e46f8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections/post.py @@ -0,0 +1,380 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument +from gooddata_api_client.model.json_api_custom_geo_collection_in_document import JsonApiCustomGeoCollectionInDocument + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = JsonApiCustomGeoCollectionInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiCustomGeoCollectionInDocument + + +request_body_json_api_custom_geo_collection_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiCustomGeoCollectionOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiCustomGeoCollectionOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_custom_geo_collection_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityCustomGeoCollections(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_custom_geo_collections_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_custom_geo_collections_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections/post.pyi new file mode 100644 index 000000000..b95516ee1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections/post.pyi @@ -0,0 +1,375 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument +from gooddata_api_client.model.json_api_custom_geo_collection_in_document import JsonApiCustomGeoCollectionInDocument + +# body param +SchemaForRequestBodyApplicationJson = JsonApiCustomGeoCollectionInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiCustomGeoCollectionInDocument + + +request_body_json_api_custom_geo_collection_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiCustomGeoCollectionOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiCustomGeoCollectionOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_custom_geo_collection_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityCustomGeoCollections(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_custom_geo_collections_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_custom_geo_collections_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/__init__.py new file mode 100644 index 000000000..0b15cfdb5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_custom_geo_collections_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_CUSTOM_GEO_COLLECTIONS_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/delete.py new file mode 100644 index 000000000..ef1dd4048 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/delete.py @@ -0,0 +1,323 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_custom_geo_collections_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityCustomGeoCollections(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_custom_geo_collections( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_custom_geo_collections_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_custom_geo_collections_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/delete.pyi new file mode 100644 index 000000000..d9bd60ca8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/delete.pyi @@ -0,0 +1,313 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_custom_geo_collections_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityCustomGeoCollections(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_custom_geo_collections( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_custom_geo_collections_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_custom_geo_collections_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/get.py new file mode 100644 index 000000000..7cd0825fc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/get.py @@ -0,0 +1,361 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiCustomGeoCollectionOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiCustomGeoCollectionOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_custom_geo_collections_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityCustomGeoCollections(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_custom_geo_collections( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_custom_geo_collections_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_custom_geo_collections_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/get.pyi new file mode 100644 index 000000000..613812f9f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/get.pyi @@ -0,0 +1,351 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiCustomGeoCollectionOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiCustomGeoCollectionOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_custom_geo_collections_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_custom_geo_collections_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityCustomGeoCollections(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_custom_geo_collections( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_custom_geo_collections( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_custom_geo_collections_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_custom_geo_collections_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/patch.py new file mode 100644 index 000000000..62760a6d3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/patch.py @@ -0,0 +1,510 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiCustomGeoCollectionPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiCustomGeoCollectionPatchDocument + + +request_body_json_api_custom_geo_collection_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiCustomGeoCollectionOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiCustomGeoCollectionOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_custom_geo_collection_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityCustomGeoCollections(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_custom_geo_collections_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_custom_geo_collections_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/patch.pyi new file mode 100644 index 000000000..ca81ebab1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/patch.pyi @@ -0,0 +1,500 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiCustomGeoCollectionPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiCustomGeoCollectionPatchDocument + + +request_body_json_api_custom_geo_collection_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiCustomGeoCollectionOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiCustomGeoCollectionOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_custom_geo_collection_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityCustomGeoCollections(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_custom_geo_collections_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_custom_geo_collections_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/put.py new file mode 100644 index 000000000..9e1e574d3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/put.py @@ -0,0 +1,510 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument +from gooddata_api_client.model.json_api_custom_geo_collection_in_document import JsonApiCustomGeoCollectionInDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiCustomGeoCollectionInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiCustomGeoCollectionInDocument + + +request_body_json_api_custom_geo_collection_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiCustomGeoCollectionOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiCustomGeoCollectionOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_custom_geo_collection_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityCustomGeoCollections(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_custom_geo_collections_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_custom_geo_collections_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/put.pyi new file mode 100644 index 000000000..1facf5255 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_custom_geo_collections_id/put.pyi @@ -0,0 +1,500 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument +from gooddata_api_client.model.json_api_custom_geo_collection_in_document import JsonApiCustomGeoCollectionInDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiCustomGeoCollectionInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiCustomGeoCollectionInDocument + + +request_body_json_api_custom_geo_collection_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiCustomGeoCollectionOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiCustomGeoCollectionOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_custom_geo_collection_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityCustomGeoCollections(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_custom_geo_collections_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_custom_geo_collections_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates/__init__.py new file mode 100644 index 000000000..81155f602 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_export_templates import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_EXPORT_TEMPLATES \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates/get.py new file mode 100644 index 000000000..c7b79fe18 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates/get.py @@ -0,0 +1,403 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportTemplateOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportTemplateOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_export_templates_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + GET all Export Template entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesExportTemplates(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_export_templates( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_export_templates_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_export_templates_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates/get.pyi new file mode 100644 index 000000000..e0d854292 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates/get.pyi @@ -0,0 +1,389 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportTemplateOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportTemplateOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_export_templates_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + GET all Export Template entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesExportTemplates(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_export_templates( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_export_templates_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_export_templates_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates/post.py new file mode 100644 index 000000000..24c188518 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates/post.py @@ -0,0 +1,381 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = JsonApiExportTemplatePostOptionalIdDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiExportTemplatePostOptionalIdDocument + + +request_body_json_api_export_template_post_optional_id_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiExportTemplateOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiExportTemplateOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Export Template entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_export_template_post_optional_id_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityExportTemplates(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_export_templates_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_export_templates_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates/post.pyi new file mode 100644 index 000000000..bb160474e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates/post.pyi @@ -0,0 +1,376 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument + +# body param +SchemaForRequestBodyApplicationJson = JsonApiExportTemplatePostOptionalIdDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiExportTemplatePostOptionalIdDocument + + +request_body_json_api_export_template_post_optional_id_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiExportTemplateOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiExportTemplateOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Export Template entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_export_template_post_optional_id_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityExportTemplates(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_export_templates_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_export_templates_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/__init__.py new file mode 100644 index 000000000..be15d1f97 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_export_templates_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_EXPORT_TEMPLATES_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/delete.py new file mode 100644 index 000000000..44ef852b5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/delete.py @@ -0,0 +1,324 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_export_templates_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete Export Template entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityExportTemplates(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_export_templates( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_export_templates_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_export_templates_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/delete.pyi new file mode 100644 index 000000000..a1e6eccc7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/delete.pyi @@ -0,0 +1,314 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_export_templates_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete Export Template entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityExportTemplates(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_export_templates( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_export_templates_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_export_templates_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/get.py new file mode 100644 index 000000000..b83d8d02a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/get.py @@ -0,0 +1,362 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportTemplateOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportTemplateOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_export_templates_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + GET Export Template entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityExportTemplates(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_export_templates( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_export_templates_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_export_templates_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/get.pyi new file mode 100644 index 000000000..6ccdf3075 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/get.pyi @@ -0,0 +1,352 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportTemplateOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportTemplateOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_export_templates_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_export_templates_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + GET Export Template entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityExportTemplates(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_export_templates( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_export_templates( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_export_templates_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_export_templates_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/patch.py new file mode 100644 index 000000000..7fac50710 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/patch.py @@ -0,0 +1,511 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiExportTemplatePatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiExportTemplatePatchDocument + + +request_body_json_api_export_template_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportTemplateOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportTemplateOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch Export Template entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_export_template_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityExportTemplates(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_export_templates_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_export_templates_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/patch.pyi new file mode 100644 index 000000000..48d9ac18b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/patch.pyi @@ -0,0 +1,501 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiExportTemplatePatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiExportTemplatePatchDocument + + +request_body_json_api_export_template_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportTemplateOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportTemplateOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch Export Template entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_export_template_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityExportTemplates(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_export_templates_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_export_templates_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/put.py new file mode 100644 index 000000000..4f9db5da8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/put.py @@ -0,0 +1,511 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiExportTemplateInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiExportTemplateInDocument + + +request_body_json_api_export_template_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportTemplateOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportTemplateOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + PUT Export Template entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_export_template_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityExportTemplates(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_export_templates_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_export_templates_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/put.pyi new file mode 100644 index 000000000..782160f4b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_export_templates_id/put.pyi @@ -0,0 +1,501 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiExportTemplateInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiExportTemplateInDocument + + +request_body_json_api_export_template_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportTemplateOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportTemplateOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + PUT Export Template entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_export_template_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityExportTemplates(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_export_templates_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_export_templates_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers/__init__.py new file mode 100644 index 000000000..81da13e99 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_identity_providers import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_IDENTITY_PROVIDERS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers/get.py new file mode 100644 index 000000000..8541118ec --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers/get.py @@ -0,0 +1,403 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiIdentityProviderOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiIdentityProviderOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_identity_providers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all Identity Providers + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesIdentityProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_identity_providers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_identity_providers_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_identity_providers_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers/get.pyi new file mode 100644 index 000000000..13f32c0a2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers/get.pyi @@ -0,0 +1,389 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiIdentityProviderOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiIdentityProviderOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_identity_providers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all Identity Providers + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesIdentityProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_identity_providers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_identity_providers_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_identity_providers_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers/post.py new file mode 100644 index 000000000..cd93f243b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers/post.py @@ -0,0 +1,381 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = JsonApiIdentityProviderInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiIdentityProviderInDocument + + +request_body_json_api_identity_provider_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiIdentityProviderOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiIdentityProviderOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Identity Providers + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_identity_provider_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityIdentityProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_identity_providers_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_identity_providers_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers/post.pyi new file mode 100644 index 000000000..4b9720cbd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers/post.pyi @@ -0,0 +1,376 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument + +# body param +SchemaForRequestBodyApplicationJson = JsonApiIdentityProviderInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiIdentityProviderInDocument + + +request_body_json_api_identity_provider_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiIdentityProviderOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiIdentityProviderOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Identity Providers + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_identity_provider_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityIdentityProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_identity_providers_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_identity_providers_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/__init__.py new file mode 100644 index 000000000..047112164 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_identity_providers_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_IDENTITY_PROVIDERS_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/delete.py new file mode 100644 index 000000000..f3bcc8834 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/delete.py @@ -0,0 +1,324 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_identity_providers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete Identity Provider + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityIdentityProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_identity_providers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_identity_providers_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_identity_providers_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/delete.pyi new file mode 100644 index 000000000..62f68616b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/delete.pyi @@ -0,0 +1,314 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_identity_providers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete Identity Provider + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityIdentityProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_identity_providers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_identity_providers_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_identity_providers_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/get.py new file mode 100644 index 000000000..bf49ed99e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/get.py @@ -0,0 +1,362 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiIdentityProviderOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiIdentityProviderOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_identity_providers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Identity Provider + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityIdentityProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_identity_providers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_identity_providers_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_identity_providers_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/get.pyi new file mode 100644 index 000000000..907d8bbc6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/get.pyi @@ -0,0 +1,352 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiIdentityProviderOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiIdentityProviderOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_identity_providers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_identity_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Identity Provider + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityIdentityProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_identity_providers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_identity_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_identity_providers_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_identity_providers_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/patch.py new file mode 100644 index 000000000..c976b46e1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/patch.py @@ -0,0 +1,511 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiIdentityProviderPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiIdentityProviderPatchDocument + + +request_body_json_api_identity_provider_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiIdentityProviderOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiIdentityProviderOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch Identity Provider + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_identity_provider_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityIdentityProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_identity_providers_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_identity_providers_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/patch.pyi new file mode 100644 index 000000000..a400faec8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/patch.pyi @@ -0,0 +1,501 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiIdentityProviderPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiIdentityProviderPatchDocument + + +request_body_json_api_identity_provider_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiIdentityProviderOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiIdentityProviderOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch Identity Provider + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_identity_provider_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityIdentityProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_identity_providers_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_identity_providers_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/put.py new file mode 100644 index 000000000..6f36514ad --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/put.py @@ -0,0 +1,511 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiIdentityProviderInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiIdentityProviderInDocument + + +request_body_json_api_identity_provider_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiIdentityProviderOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiIdentityProviderOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Put Identity Provider + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_identity_provider_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityIdentityProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_identity_providers_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_identity_providers_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/put.pyi new file mode 100644 index 000000000..02e085c3f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_identity_providers_id/put.pyi @@ -0,0 +1,501 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiIdentityProviderInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiIdentityProviderInDocument + + +request_body_json_api_identity_provider_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiIdentityProviderOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiIdentityProviderOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Put Identity Provider + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_identity_provider_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityIdentityProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_identity_providers_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_identity_providers_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks/__init__.py new file mode 100644 index 000000000..330e33642 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_jwks import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_JWKS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks/get.py new file mode 100644 index 000000000..22e1f1383 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks/get.py @@ -0,0 +1,403 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiJwkOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiJwkOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_jwks_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all Jwks + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesJwks(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_jwks( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_jwks_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_jwks_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks/get.pyi new file mode 100644 index 000000000..6ce7934c3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks/get.pyi @@ -0,0 +1,389 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiJwkOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiJwkOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_jwks_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all Jwks + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesJwks(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_jwks( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_jwks_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_jwks_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks/post.py new file mode 100644 index 000000000..d53553ecd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks/post.py @@ -0,0 +1,381 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = JsonApiJwkInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiJwkInDocument + + +request_body_json_api_jwk_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiJwkOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiJwkOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Jwks + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_jwk_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityJwks(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_jwks_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_jwks_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks/post.pyi new file mode 100644 index 000000000..c0d2b61a6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks/post.pyi @@ -0,0 +1,376 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument + +# body param +SchemaForRequestBodyApplicationJson = JsonApiJwkInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiJwkInDocument + + +request_body_json_api_jwk_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiJwkOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiJwkOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Jwks + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_jwk_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityJwks(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_jwks_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_jwks_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/__init__.py new file mode 100644 index 000000000..fc2b78a91 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_jwks_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_JWKS_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/delete.py new file mode 100644 index 000000000..8bc892172 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/delete.py @@ -0,0 +1,324 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_jwks_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete Jwk + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityJwks(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_jwks( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_jwks_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_jwks_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/delete.pyi new file mode 100644 index 000000000..27f2d1436 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/delete.pyi @@ -0,0 +1,314 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_jwks_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete Jwk + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityJwks(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_jwks( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_jwks_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_jwks_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/get.py new file mode 100644 index 000000000..72eb4d950 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/get.py @@ -0,0 +1,362 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiJwkOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiJwkOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_jwks_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Jwk + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityJwks(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_jwks( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_jwks_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_jwks_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/get.pyi new file mode 100644 index 000000000..6963b8e42 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/get.pyi @@ -0,0 +1,352 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiJwkOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiJwkOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_jwks_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_jwks_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Jwk + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityJwks(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_jwks( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_jwks( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_jwks_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_jwks_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/patch.py new file mode 100644 index 000000000..c80566862 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/patch.py @@ -0,0 +1,511 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiJwkPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiJwkPatchDocument + + +request_body_json_api_jwk_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiJwkOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiJwkOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch Jwk + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_jwk_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityJwks(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_jwks_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_jwks_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/patch.pyi new file mode 100644 index 000000000..2a71a8f2e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/patch.pyi @@ -0,0 +1,501 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_jwk_patch_document import JsonApiJwkPatchDocument +from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiJwkPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiJwkPatchDocument + + +request_body_json_api_jwk_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiJwkOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiJwkOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch Jwk + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_jwk_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityJwks(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_jwks_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_jwks_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/put.py new file mode 100644 index 000000000..b30dc7416 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/put.py @@ -0,0 +1,511 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiJwkInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiJwkInDocument + + +request_body_json_api_jwk_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiJwkOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiJwkOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Put Jwk + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_jwk_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityJwks(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_jwks_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_jwks_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/put.pyi new file mode 100644 index 000000000..b09e25e68 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_jwks_id/put.pyi @@ -0,0 +1,501 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_jwk_in_document import JsonApiJwkInDocument +from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiJwkInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiJwkInDocument + + +request_body_json_api_jwk_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiJwkOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiJwkOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_jwks_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Put Jwk + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_jwk_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityJwks(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_jwks( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_jwks_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_jwks_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints/__init__.py new file mode 100644 index 000000000..dd02c25b3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_llm_endpoints import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_LLM_ENDPOINTS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints/get.py new file mode 100644 index 000000000..b87936130 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints/get.py @@ -0,0 +1,403 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLlmEndpointOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLlmEndpointOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_llm_endpoints_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all LLM endpoint entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesLlmEndpoints(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_llm_endpoints( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_llm_endpoints_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_llm_endpoints_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints/get.pyi new file mode 100644 index 000000000..d2efa61d0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints/get.pyi @@ -0,0 +1,389 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_endpoint_out_list import JsonApiLlmEndpointOutList + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLlmEndpointOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLlmEndpointOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_llm_endpoints_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all LLM endpoint entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesLlmEndpoints(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_llm_endpoints( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_llm_endpoints_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_llm_endpoints_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints/post.py new file mode 100644 index 000000000..c9d963d15 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints/post.py @@ -0,0 +1,381 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = JsonApiLlmEndpointInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiLlmEndpointInDocument + + +request_body_json_api_llm_endpoint_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiLlmEndpointOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiLlmEndpointOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post LLM endpoint entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_llm_endpoint_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityLlmEndpoints(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_llm_endpoints_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_llm_endpoints_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints/post.pyi new file mode 100644 index 000000000..84d4b10d1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints/post.pyi @@ -0,0 +1,376 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument + +# body param +SchemaForRequestBodyApplicationJson = JsonApiLlmEndpointInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiLlmEndpointInDocument + + +request_body_json_api_llm_endpoint_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiLlmEndpointOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiLlmEndpointOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post LLM endpoint entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_llm_endpoint_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityLlmEndpoints(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_llm_endpoints_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_llm_endpoints_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/__init__.py new file mode 100644 index 000000000..77e24f3cf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_llm_endpoints_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_LLM_ENDPOINTS_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/delete.py new file mode 100644 index 000000000..87e0f9a45 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/delete.py @@ -0,0 +1,323 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_llm_endpoints_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityLlmEndpoints(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_llm_endpoints( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_llm_endpoints_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_llm_endpoints_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/delete.pyi new file mode 100644 index 000000000..343f27f09 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/delete.pyi @@ -0,0 +1,313 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_llm_endpoints_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityLlmEndpoints(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_llm_endpoints( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_llm_endpoints_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_llm_endpoints_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/get.py new file mode 100644 index 000000000..32d3d091c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/get.py @@ -0,0 +1,362 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLlmEndpointOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLlmEndpointOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_llm_endpoints_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get LLM endpoint entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityLlmEndpoints(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_llm_endpoints( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_llm_endpoints_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_llm_endpoints_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/get.pyi new file mode 100644 index 000000000..7598e0e07 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/get.pyi @@ -0,0 +1,352 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLlmEndpointOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLlmEndpointOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_llm_endpoints_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_llm_endpoints_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get LLM endpoint entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityLlmEndpoints(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_llm_endpoints( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_llm_endpoints( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_llm_endpoints_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_llm_endpoints_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/patch.py new file mode 100644 index 000000000..8d56afa67 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/patch.py @@ -0,0 +1,511 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.model.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiLlmEndpointPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiLlmEndpointPatchDocument + + +request_body_json_api_llm_endpoint_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLlmEndpointOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLlmEndpointOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch LLM endpoint entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_llm_endpoint_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityLlmEndpoints(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_llm_endpoints_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_llm_endpoints_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/patch.pyi new file mode 100644 index 000000000..ee0aa2f8f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/patch.pyi @@ -0,0 +1,501 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument +from gooddata_api_client.model.json_api_llm_endpoint_patch_document import JsonApiLlmEndpointPatchDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiLlmEndpointPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiLlmEndpointPatchDocument + + +request_body_json_api_llm_endpoint_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLlmEndpointOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLlmEndpointOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch LLM endpoint entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_llm_endpoint_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityLlmEndpoints(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_llm_endpoints_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_llm_endpoints_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/put.py new file mode 100644 index 000000000..245f3348b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/put.py @@ -0,0 +1,511 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiLlmEndpointInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiLlmEndpointInDocument + + +request_body_json_api_llm_endpoint_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLlmEndpointOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLlmEndpointOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + PUT LLM endpoint entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_llm_endpoint_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityLlmEndpoints(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_llm_endpoints_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_llm_endpoints_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/put.pyi new file mode 100644 index 000000000..7273de234 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_endpoints_id/put.pyi @@ -0,0 +1,501 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_endpoint_in_document import JsonApiLlmEndpointInDocument +from gooddata_api_client.model.json_api_llm_endpoint_out_document import JsonApiLlmEndpointOutDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiLlmEndpointInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiLlmEndpointInDocument + + +request_body_json_api_llm_endpoint_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLlmEndpointOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLlmEndpointOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_llm_endpoints_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + PUT LLM endpoint entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_llm_endpoint_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityLlmEndpoints(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_llm_endpoints( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_llm_endpoints_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_llm_endpoints_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers/__init__.py new file mode 100644 index 000000000..a37c2fd9a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_llm_providers import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_LLM_PROVIDERS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers/get.py new file mode 100644 index 000000000..0aac2c013 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers/get.py @@ -0,0 +1,403 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_provider_out_list import JsonApiLlmProviderOutList + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLlmProviderOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLlmProviderOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_llm_providers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all LLM Provider entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesLlmProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_llm_providers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_llm_providers_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_llm_providers_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers/get.pyi new file mode 100644 index 000000000..3b363c373 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers/get.pyi @@ -0,0 +1,389 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_provider_out_list import JsonApiLlmProviderOutList + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLlmProviderOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLlmProviderOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_llm_providers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all LLM Provider entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesLlmProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_llm_providers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_llm_providers_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_llm_providers_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers/post.py new file mode 100644 index 000000000..978e10e12 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers/post.py @@ -0,0 +1,381 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument +from gooddata_api_client.model.json_api_llm_provider_in_document import JsonApiLlmProviderInDocument + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = JsonApiLlmProviderInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiLlmProviderInDocument + + +request_body_json_api_llm_provider_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiLlmProviderOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiLlmProviderOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post LLM Provider entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_llm_provider_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityLlmProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_llm_providers_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_llm_providers_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers/post.pyi new file mode 100644 index 000000000..3834055f1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers/post.pyi @@ -0,0 +1,376 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument +from gooddata_api_client.model.json_api_llm_provider_in_document import JsonApiLlmProviderInDocument + +# body param +SchemaForRequestBodyApplicationJson = JsonApiLlmProviderInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiLlmProviderInDocument + + +request_body_json_api_llm_provider_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiLlmProviderOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiLlmProviderOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post LLM Provider entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_llm_provider_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityLlmProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_llm_providers_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_llm_providers_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/__init__.py new file mode 100644 index 000000000..abfc0cb9e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_llm_providers_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_LLM_PROVIDERS_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/delete.py new file mode 100644 index 000000000..855040f83 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/delete.py @@ -0,0 +1,324 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_llm_providers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete LLM Provider entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityLlmProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_llm_providers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_llm_providers_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_llm_providers_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/delete.pyi new file mode 100644 index 000000000..056034c8e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/delete.pyi @@ -0,0 +1,314 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_llm_providers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete LLM Provider entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityLlmProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_llm_providers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_llm_providers_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_llm_providers_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/get.py new file mode 100644 index 000000000..d02236a01 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/get.py @@ -0,0 +1,362 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLlmProviderOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLlmProviderOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_llm_providers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get LLM Provider entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityLlmProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_llm_providers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_llm_providers_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_llm_providers_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/get.pyi new file mode 100644 index 000000000..8caa74b50 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/get.pyi @@ -0,0 +1,352 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLlmProviderOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLlmProviderOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_llm_providers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_llm_providers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get LLM Provider entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityLlmProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_llm_providers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_llm_providers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_llm_providers_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_llm_providers_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/patch.py new file mode 100644 index 000000000..06cf2108e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/patch.py @@ -0,0 +1,511 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiLlmProviderPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiLlmProviderPatchDocument + + +request_body_json_api_llm_provider_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLlmProviderOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLlmProviderOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch LLM Provider entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_llm_provider_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityLlmProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_llm_providers_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_llm_providers_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/patch.pyi new file mode 100644 index 000000000..4fafa6335 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/patch.pyi @@ -0,0 +1,501 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiLlmProviderPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiLlmProviderPatchDocument + + +request_body_json_api_llm_provider_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLlmProviderOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLlmProviderOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch LLM Provider entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_llm_provider_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityLlmProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_llm_providers_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_llm_providers_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/put.py new file mode 100644 index 000000000..23cb47c61 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/put.py @@ -0,0 +1,511 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument +from gooddata_api_client.model.json_api_llm_provider_in_document import JsonApiLlmProviderInDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiLlmProviderInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiLlmProviderInDocument + + +request_body_json_api_llm_provider_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLlmProviderOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLlmProviderOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + PUT LLM Provider entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_llm_provider_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityLlmProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_llm_providers_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_llm_providers_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/put.pyi new file mode 100644 index 000000000..d8889c25a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_llm_providers_id/put.pyi @@ -0,0 +1,501 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument +from gooddata_api_client.model.json_api_llm_provider_in_document import JsonApiLlmProviderInDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiLlmProviderInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiLlmProviderInDocument + + +request_body_json_api_llm_provider_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLlmProviderOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLlmProviderOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_llm_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + PUT LLM Provider entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_llm_provider_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityLlmProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_llm_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_llm_providers_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_llm_providers_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers/__init__.py new file mode 100644 index 000000000..a0e16f59d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_notification_channel_identifiers import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_NOTIFICATION_CHANNEL_IDENTIFIERS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers/get.py new file mode 100644 index 000000000..19af8e55c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers/get.py @@ -0,0 +1,402 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiNotificationChannelIdentifierOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiNotificationChannelIdentifierOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_notification_channel_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_notification_channel_identifiers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_notification_channel_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_notification_channel_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesNotificationChannelIdentifiers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_notification_channel_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_notification_channel_identifiers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_notification_channel_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_notification_channel_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_notification_channel_identifiers_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_notification_channel_identifiers_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers/get.pyi new file mode 100644 index 000000000..a93f23f0c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers/get.pyi @@ -0,0 +1,388 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiNotificationChannelIdentifierOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiNotificationChannelIdentifierOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_notification_channel_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_notification_channel_identifiers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_notification_channel_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_notification_channel_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesNotificationChannelIdentifiers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_notification_channel_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_notification_channel_identifiers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_notification_channel_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_notification_channel_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_notification_channel_identifiers_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_notification_channel_identifiers_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers_id/__init__.py new file mode 100644 index 000000000..39019b604 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_notification_channel_identifiers_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_NOTIFICATION_CHANNEL_IDENTIFIERS_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers_id/get.py new file mode 100644 index 000000000..e1c722886 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers_id/get.py @@ -0,0 +1,361 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiNotificationChannelIdentifierOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiNotificationChannelIdentifierOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_notification_channel_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_notification_channel_identifiers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_notification_channel_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_notification_channel_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityNotificationChannelIdentifiers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_notification_channel_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_notification_channel_identifiers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_notification_channel_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_notification_channel_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_notification_channel_identifiers_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_notification_channel_identifiers_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers_id/get.pyi new file mode 100644 index 000000000..bbd128c03 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channel_identifiers_id/get.pyi @@ -0,0 +1,351 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiNotificationChannelIdentifierOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiNotificationChannelIdentifierOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_notification_channel_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_notification_channel_identifiers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_notification_channel_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_notification_channel_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityNotificationChannelIdentifiers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_notification_channel_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_notification_channel_identifiers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_notification_channel_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_notification_channel_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_notification_channel_identifiers_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_notification_channel_identifiers_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels/__init__.py new file mode 100644 index 000000000..a3a47c4d1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_notification_channels import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_NOTIFICATION_CHANNELS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels/get.py new file mode 100644 index 000000000..03bddabd5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels/get.py @@ -0,0 +1,403 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiNotificationChannelOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiNotificationChannelOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_notification_channels_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all Notification Channel entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesNotificationChannels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_notification_channels( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_notification_channels_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_notification_channels_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels/get.pyi new file mode 100644 index 000000000..4e8232748 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels/get.pyi @@ -0,0 +1,389 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiNotificationChannelOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiNotificationChannelOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_notification_channels_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all Notification Channel entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesNotificationChannels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_notification_channels( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_notification_channels_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_notification_channels_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels/post.py new file mode 100644 index 000000000..9b1d26d32 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels/post.py @@ -0,0 +1,381 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.model.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = JsonApiNotificationChannelPostOptionalIdDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiNotificationChannelPostOptionalIdDocument + + +request_body_json_api_notification_channel_post_optional_id_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiNotificationChannelOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiNotificationChannelOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Notification Channel entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_notification_channel_post_optional_id_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityNotificationChannels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_notification_channels_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_notification_channels_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels/post.pyi new file mode 100644 index 000000000..3add3cce8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels/post.pyi @@ -0,0 +1,376 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.model.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument + +# body param +SchemaForRequestBodyApplicationJson = JsonApiNotificationChannelPostOptionalIdDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiNotificationChannelPostOptionalIdDocument + + +request_body_json_api_notification_channel_post_optional_id_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiNotificationChannelOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiNotificationChannelOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Notification Channel entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_notification_channel_post_optional_id_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityNotificationChannels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_notification_channels_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_notification_channels_oapg( + body=body, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/__init__.py new file mode 100644 index 000000000..8986a98bf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_notification_channels_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_NOTIFICATION_CHANNELS_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/delete.py new file mode 100644 index 000000000..d43152cc1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/delete.py @@ -0,0 +1,324 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_notification_channels_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete Notification Channel entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityNotificationChannels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_notification_channels( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_notification_channels_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_notification_channels_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/delete.pyi new file mode 100644 index 000000000..c39091393 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/delete.pyi @@ -0,0 +1,314 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_notification_channels_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete Notification Channel entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityNotificationChannels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_notification_channels( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_notification_channels_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_notification_channels_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/get.py new file mode 100644 index 000000000..44390037d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/get.py @@ -0,0 +1,362 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiNotificationChannelOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiNotificationChannelOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_notification_channels_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Notification Channel entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityNotificationChannels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_notification_channels( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_notification_channels_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_notification_channels_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/get.pyi new file mode 100644 index 000000000..13f496185 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/get.pyi @@ -0,0 +1,352 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiNotificationChannelOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiNotificationChannelOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_notification_channels_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_notification_channels_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Notification Channel entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityNotificationChannels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_notification_channels( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_notification_channels( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_notification_channels_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_notification_channels_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/patch.py new file mode 100644 index 000000000..6f810d333 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/patch.py @@ -0,0 +1,511 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiNotificationChannelPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiNotificationChannelPatchDocument + + +request_body_json_api_notification_channel_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiNotificationChannelOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiNotificationChannelOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch Notification Channel entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_notification_channel_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityNotificationChannels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_notification_channels_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_notification_channels_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/patch.pyi new file mode 100644 index 000000000..bc66d2274 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/patch.pyi @@ -0,0 +1,501 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiNotificationChannelPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiNotificationChannelPatchDocument + + +request_body_json_api_notification_channel_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiNotificationChannelOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiNotificationChannelOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch Notification Channel entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_notification_channel_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityNotificationChannels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_notification_channels_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_notification_channels_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/put.py new file mode 100644 index 000000000..6a065af63 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/put.py @@ -0,0 +1,511 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument +from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiNotificationChannelInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiNotificationChannelInDocument + + +request_body_json_api_notification_channel_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiNotificationChannelOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiNotificationChannelOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Put Notification Channel entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_notification_channel_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityNotificationChannels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_notification_channels_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_notification_channels_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/put.pyi new file mode 100644 index 000000000..6699705d6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_notification_channels_id/put.pyi @@ -0,0 +1,501 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_notification_channel_in_document import JsonApiNotificationChannelInDocument +from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiNotificationChannelInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiNotificationChannelInDocument + + +request_body_json_api_notification_channel_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiNotificationChannelOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiNotificationChannelOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Put Notification Channel entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_notification_channel_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityNotificationChannels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_notification_channels_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_notification_channels_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_workspace_automations/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_workspace_automations/__init__.py new file mode 100644 index 000000000..b3dc195a6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_workspace_automations/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_organization_workspace_automations import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_ORGANIZATION_WORKSPACE_AUTOMATIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_workspace_automations/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_workspace_automations/get.py new file mode 100644 index 000000000..d94ddfaee --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_workspace_automations/get.py @@ -0,0 +1,513 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList + +from . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "workspaces": "WORKSPACES", + "notificationChannels": "NOTIFICATION_CHANNELS", + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "userIdentifiers": "USER_IDENTIFIERS", + "exportDefinitions": "EXPORT_DEFINITIONS", + "users": "USERS", + "automationResults": "AUTOMATION_RESULTS", + "workspace": "WORKSPACE", + "notificationChannel": "NOTIFICATION_CHANNEL", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "recipients": "RECIPIENTS", + "ALL": "ALL", + } + + @schemas.classproperty + def WORKSPACES(cls): + return cls("workspaces") + + @schemas.classproperty + def NOTIFICATION_CHANNELS(cls): + return cls("notificationChannels") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def EXPORT_DEFINITIONS(cls): + return cls("exportDefinitions") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def AUTOMATION_RESULTS(cls): + return cls("automationResults") + + @schemas.classproperty + def WORKSPACE(cls): + return cls("workspace") + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def RECIPIENTS(cls): + return cls("recipients") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiWorkspaceAutomationOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiWorkspaceAutomationOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_automations_workspace_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_automations_workspace_automations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_automations_workspace_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_automations_workspace_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all Automations across all Workspaces + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllAutomationsWorkspaceAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_automations_workspace_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_automations_workspace_automations( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_automations_workspace_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_automations_workspace_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_automations_workspace_automations_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_automations_workspace_automations_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_workspace_automations/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_workspace_automations/get.pyi new file mode 100644 index 000000000..f00417927 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_organization_workspace_automations/get.pyi @@ -0,0 +1,480 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def WORKSPACES(cls): + return cls("workspaces") + + @schemas.classproperty + def NOTIFICATION_CHANNELS(cls): + return cls("notificationChannels") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def EXPORT_DEFINITIONS(cls): + return cls("exportDefinitions") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def AUTOMATION_RESULTS(cls): + return cls("automationResults") + + @schemas.classproperty + def WORKSPACE(cls): + return cls("workspace") + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def RECIPIENTS(cls): + return cls("recipients") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiWorkspaceAutomationOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiWorkspaceAutomationOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_automations_workspace_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_automations_workspace_automations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_automations_workspace_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_automations_workspace_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all Automations across all Workspaces + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllAutomationsWorkspaceAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_automations_workspace_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_automations_workspace_automations( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_automations_workspace_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_automations_workspace_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_automations_workspace_automations_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_automations_workspace_automations_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers/__init__.py new file mode 100644 index 000000000..f3d74c137 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_user_identifiers import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_USER_IDENTIFIERS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers/get.py new file mode 100644 index 000000000..f5833da4d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers/get.py @@ -0,0 +1,403 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiUserIdentifierOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiUserIdentifierOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_user_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_user_identifiers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_user_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_user_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get UserIdentifier entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesUserIdentifiers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_user_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_user_identifiers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_user_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_user_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_user_identifiers_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_user_identifiers_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers/get.pyi new file mode 100644 index 000000000..014d6df89 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers/get.pyi @@ -0,0 +1,389 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList + +# Query params +FilterSchema = schemas.StrSchema +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiUserIdentifierOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiUserIdentifierOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_user_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_user_identifiers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_user_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_user_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get UserIdentifier entities + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + used_path = path.value + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesUserIdentifiers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_user_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_user_identifiers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_user_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_user_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_user_identifiers_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_user_identifiers_oapg( + query_params=query_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers_id/__init__.py new file mode 100644 index 000000000..9a293f094 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_user_identifiers_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_USER_IDENTIFIERS_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers_id/get.py new file mode 100644 index 000000000..0a9f14b3f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers_id/get.py @@ -0,0 +1,362 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + + + class MetaOapg: + regex=[{ + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }] +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiUserIdentifierOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiUserIdentifierOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_user_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_user_identifiers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_user_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_user_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get UserIdentifier entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityUserIdentifiers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_user_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_user_identifiers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_user_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_user_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_user_identifiers_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_user_identifiers_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers_id/get.pyi new file mode 100644 index 000000000..ed3c996b4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_user_identifiers_id/get.pyi @@ -0,0 +1,352 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params + + +class IdSchema( + schemas.StrSchema +): + pass +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'id': typing.Union[IdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_id = api_client.PathParameter( + name="id", + style=api_client.ParameterStyle.SIMPLE, + schema=IdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiUserIdentifierOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiUserIdentifierOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_user_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_user_identifiers_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_user_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_user_identifiers_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get UserIdentifier entity + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityUserIdentifiers(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_user_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_user_identifiers( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_user_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_user_identifiers( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_user_identifiers_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_user_identifiers_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts/__init__.py new file mode 100644 index 000000000..fae1c0a81 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_aggregated_facts import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_AGGREGATED_FACTS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts/get.py new file mode 100644 index 000000000..b6adc1146 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts/get.py @@ -0,0 +1,608 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "datasets": "DATASETS", + "facts": "FACTS", + "dataset": "DATASET", + "sourceFact": "SOURCE_FACT", + "ALL": "ALL", + } + + @schemas.classproperty + def DATASETS(cls): + return cls("datasets") + + @schemas.classproperty + def FACTS(cls): + return cls("facts") + + @schemas.classproperty + def DATASET(cls): + return cls("dataset") + + @schemas.classproperty + def SOURCE_FACT(cls): + return cls("sourceFact") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAggregatedFactOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAggregatedFactOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_aggregated_facts_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_aggregated_facts_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_aggregated_facts_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_aggregated_facts_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + request_query_filter, + request_query_include, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesAggregatedFacts(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_aggregated_facts( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_aggregated_facts( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_aggregated_facts( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_aggregated_facts( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_aggregated_facts_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_aggregated_facts_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts/get.pyi new file mode 100644 index 000000000..67b73ef44 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts/get.pyi @@ -0,0 +1,575 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DATASETS(cls): + return cls("datasets") + + @schemas.classproperty + def FACTS(cls): + return cls("facts") + + @schemas.classproperty + def DATASET(cls): + return cls("dataset") + + @schemas.classproperty + def SOURCE_FACT(cls): + return cls("sourceFact") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAggregatedFactOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAggregatedFactOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_aggregated_facts_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_aggregated_facts_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_aggregated_facts_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_aggregated_facts_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + request_query_filter, + request_query_include, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesAggregatedFacts(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_aggregated_facts( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_aggregated_facts( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_aggregated_facts( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_aggregated_facts( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_aggregated_facts_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_aggregated_facts_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_object_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_object_id/__init__.py new file mode 100644 index 000000000..e90f97f3b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_object_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_aggregated_facts_object_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_AGGREGATED_FACTS_OBJECT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_object_id/get.py new file mode 100644 index 000000000..5ae9d4476 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_object_id/get.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "datasets": "DATASETS", + "facts": "FACTS", + "dataset": "DATASET", + "sourceFact": "SOURCE_FACT", + "ALL": "ALL", + } + + @schemas.classproperty + def DATASETS(cls): + return cls("datasets") + + @schemas.classproperty + def FACTS(cls): + return cls("facts") + + @schemas.classproperty + def DATASET(cls): + return cls("dataset") + + @schemas.classproperty + def SOURCE_FACT(cls): + return cls("sourceFact") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAggregatedFactOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAggregatedFactOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_aggregated_facts_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_aggregated_facts_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_aggregated_facts_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_aggregated_facts_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityAggregatedFacts(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_aggregated_facts( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_aggregated_facts( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_aggregated_facts( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_aggregated_facts( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_aggregated_facts_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_aggregated_facts_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_object_id/get.pyi new file mode 100644 index 000000000..bd48cc713 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_object_id/get.pyi @@ -0,0 +1,505 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DATASETS(cls): + return cls("datasets") + + @schemas.classproperty + def FACTS(cls): + return cls("facts") + + @schemas.classproperty + def DATASET(cls): + return cls("dataset") + + @schemas.classproperty + def SOURCE_FACT(cls): + return cls("sourceFact") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAggregatedFactOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAggregatedFactOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_aggregated_facts_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_aggregated_facts_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_aggregated_facts_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_aggregated_facts_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityAggregatedFacts(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_aggregated_facts( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_aggregated_facts( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_aggregated_facts( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_aggregated_facts( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_aggregated_facts_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_aggregated_facts_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_search/__init__.py new file mode 100644 index 000000000..e36b4acac --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_aggregated_facts_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_AGGREGATED_FACTS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_search/post.py new file mode 100644 index 000000000..6375c5079 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAggregatedFactOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAggregatedFactOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_aggregated_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_aggregated_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_aggregated_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_aggregated_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_aggregated_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for AggregatedFact + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesAggregatedFacts(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_aggregated_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_aggregated_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_aggregated_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_aggregated_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_aggregated_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_aggregated_facts_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_aggregated_facts_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_search/post.pyi new file mode 100644 index 000000000..61766ef66 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_aggregated_facts_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAggregatedFactOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAggregatedFactOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_aggregated_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_aggregated_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_aggregated_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_aggregated_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_aggregated_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for AggregatedFact + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesAggregatedFacts(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_aggregated_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_aggregated_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_aggregated_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_aggregated_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_aggregated_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_aggregated_facts_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_aggregated_facts_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_search/__init__.py new file mode 100644 index 000000000..6faabc7f3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_analytical_dashboards_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_ANALYTICAL_DASHBOARDS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_search/post.py new file mode 100644 index 000000000..41bfd71ee --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAnalyticalDashboardOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAnalyticalDashboardOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_analytical_dashboards_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_analytical_dashboards_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_analytical_dashboards_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_analytical_dashboards_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_analytical_dashboards_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for AnalyticalDashboard + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesAnalyticalDashboards(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_analytical_dashboards( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_analytical_dashboards( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_analytical_dashboards( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_analytical_dashboards( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_analytical_dashboards( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_analytical_dashboards_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_analytical_dashboards_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_search/post.pyi new file mode 100644 index 000000000..6f37f4e06 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_analytical_dashboards_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAnalyticalDashboardOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAnalyticalDashboardOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_analytical_dashboards_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_analytical_dashboards_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_analytical_dashboards_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_analytical_dashboards_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_analytical_dashboards_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for AnalyticalDashboard + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesAnalyticalDashboards(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_analytical_dashboards( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_analytical_dashboards( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_analytical_dashboards( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_analytical_dashboards( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_analytical_dashboards( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_analytical_dashboards_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_analytical_dashboards_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies/__init__.py new file mode 100644 index 000000000..bfbab80c2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_ATTRIBUTE_HIERARCHIES \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies/get.py new file mode 100644 index 000000000..7cd45b31b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies/get.py @@ -0,0 +1,609 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "userIdentifiers": "USER_IDENTIFIERS", + "attributes": "ATTRIBUTES", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "ALL": "ALL", + } + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def ATTRIBUTES(cls): + return cls("attributes") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAttributeHierarchyOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_attribute_hierarchies_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all Attribute Hierarchies + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + request_query_filter, + request_query_include, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesAttributeHierarchies(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_attribute_hierarchies( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_attribute_hierarchies_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_attribute_hierarchies_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies/get.pyi new file mode 100644 index 000000000..87ab4ebe4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies/get.pyi @@ -0,0 +1,576 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def ATTRIBUTES(cls): + return cls("attributes") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAttributeHierarchyOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_attribute_hierarchies_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all Attribute Hierarchies + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + request_query_filter, + request_query_include, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesAttributeHierarchies(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_attribute_hierarchies( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_attribute_hierarchies_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_attribute_hierarchies_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies/post.py new file mode 100644 index 000000000..5f089f040 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies/post.py @@ -0,0 +1,613 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument + +from . import path + +# Query params + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "userIdentifiers": "USER_IDENTIFIERS", + "attributes": "ATTRIBUTES", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "ALL": "ALL", + } + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def ATTRIBUTES(cls): + return cls("attributes") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiAttributeHierarchyInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyInDocument + + +request_body_json_api_attribute_hierarchy_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiAttributeHierarchyOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Attribute Hierarchies + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_attribute_hierarchy_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityAttributeHierarchies(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_attribute_hierarchies_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_attribute_hierarchies_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies/post.pyi new file mode 100644 index 000000000..7991c5605 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies/post.pyi @@ -0,0 +1,589 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument + +# Query params + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def ATTRIBUTES(cls): + return cls("attributes") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiAttributeHierarchyInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyInDocument + + +request_body_json_api_attribute_hierarchy_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiAttributeHierarchyOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Attribute Hierarchies + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_attribute_hierarchy_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityAttributeHierarchies(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_attribute_hierarchies_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_attribute_hierarchies_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/__init__.py new file mode 100644 index 000000000..aca5ff462 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_ATTRIBUTE_HIERARCHIES_OBJECT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/delete.py new file mode 100644 index 000000000..304ef8859 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/delete.py @@ -0,0 +1,323 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_attribute_hierarchies_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete an Attribute Hierarchy + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityAttributeHierarchies(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_attribute_hierarchies( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_attribute_hierarchies_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_attribute_hierarchies_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/delete.pyi new file mode 100644 index 000000000..3b4c415e0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/delete.pyi @@ -0,0 +1,318 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_attribute_hierarchies_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete an Attribute Hierarchy + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityAttributeHierarchies(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_attribute_hierarchies( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_attribute_hierarchies_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_attribute_hierarchies_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/get.py new file mode 100644 index 000000000..9e1e99da3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/get.py @@ -0,0 +1,530 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "userIdentifiers": "USER_IDENTIFIERS", + "attributes": "ATTRIBUTES", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "ALL": "ALL", + } + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def ATTRIBUTES(cls): + return cls("attributes") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAttributeHierarchyOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_attribute_hierarchies_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get an Attribute Hierarchy + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityAttributeHierarchies(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_attribute_hierarchies( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_attribute_hierarchies_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_attribute_hierarchies_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/get.pyi new file mode 100644 index 000000000..a363770e1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/get.pyi @@ -0,0 +1,506 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def ATTRIBUTES(cls): + return cls("attributes") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAttributeHierarchyOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_attribute_hierarchies_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_attribute_hierarchies_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get an Attribute Hierarchy + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityAttributeHierarchies(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_attribute_hierarchies( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_attribute_hierarchies( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_attribute_hierarchies_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_attribute_hierarchies_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/patch.py new file mode 100644 index 000000000..2132a96d8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/patch.py @@ -0,0 +1,575 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "userIdentifiers": "USER_IDENTIFIERS", + "attributes": "ATTRIBUTES", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "ALL": "ALL", + } + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def ATTRIBUTES(cls): + return cls("attributes") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiAttributeHierarchyPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyPatchDocument + + +request_body_json_api_attribute_hierarchy_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAttributeHierarchyOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch an Attribute Hierarchy + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_attribute_hierarchy_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityAttributeHierarchies(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_attribute_hierarchies_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_attribute_hierarchies_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/patch.pyi new file mode 100644 index 000000000..f484d5cb7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/patch.pyi @@ -0,0 +1,560 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def ATTRIBUTES(cls): + return cls("attributes") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiAttributeHierarchyPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyPatchDocument + + +request_body_json_api_attribute_hierarchy_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAttributeHierarchyOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch an Attribute Hierarchy + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_attribute_hierarchy_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityAttributeHierarchies(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_attribute_hierarchies_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_attribute_hierarchies_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/put.py new file mode 100644 index 000000000..fe15dade4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/put.py @@ -0,0 +1,575 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "userIdentifiers": "USER_IDENTIFIERS", + "attributes": "ATTRIBUTES", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "ALL": "ALL", + } + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def ATTRIBUTES(cls): + return cls("attributes") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiAttributeHierarchyInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyInDocument + + +request_body_json_api_attribute_hierarchy_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAttributeHierarchyOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Put an Attribute Hierarchy + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_attribute_hierarchy_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityAttributeHierarchies(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_attribute_hierarchies_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_attribute_hierarchies_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/put.pyi new file mode 100644 index 000000000..63da6d774 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_object_id/put.pyi @@ -0,0 +1,560 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_attribute_hierarchy_in_document import JsonApiAttributeHierarchyInDocument +from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def ATTRIBUTES(cls): + return cls("attributes") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiAttributeHierarchyInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyInDocument + + +request_body_json_api_attribute_hierarchy_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAttributeHierarchyOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Put an Attribute Hierarchy + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_attribute_hierarchy_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityAttributeHierarchies(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_attribute_hierarchies_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_attribute_hierarchies_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_search/__init__.py new file mode 100644 index 000000000..79ed4759f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attribute_hierarchies_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_ATTRIBUTE_HIERARCHIES_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_search/post.py new file mode 100644 index 000000000..8682aa31b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAttributeHierarchyOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for AttributeHierarchy + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesAttributeHierarchies(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_attribute_hierarchies_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_attribute_hierarchies_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_search/post.pyi new file mode 100644 index 000000000..1100c8bf1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attribute_hierarchies_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAttributeHierarchyOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAttributeHierarchyOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_attribute_hierarchies_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for AttributeHierarchy + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesAttributeHierarchies(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_attribute_hierarchies( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_attribute_hierarchies_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_attribute_hierarchies_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_object_id/patch.py new file mode 100644 index 000000000..05b1ef55b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_object_id/patch.py @@ -0,0 +1,580 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "datasets": "DATASETS", + "labels": "LABELS", + "attributeHierarchies": "ATTRIBUTE_HIERARCHIES", + "dataset": "DATASET", + "defaultView": "DEFAULT_VIEW", + "ALL": "ALL", + } + + @schemas.classproperty + def DATASETS(cls): + return cls("datasets") + + @schemas.classproperty + def LABELS(cls): + return cls("labels") + + @schemas.classproperty + def ATTRIBUTE_HIERARCHIES(cls): + return cls("attributeHierarchies") + + @schemas.classproperty + def DATASET(cls): + return cls("dataset") + + @schemas.classproperty + def DEFAULT_VIEW(cls): + return cls("defaultView") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiAttributePatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiAttributePatchDocument + + +request_body_json_api_attribute_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAttributeOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAttributeOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch an Attribute (beta) + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_attribute_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityAttributes(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_attributes_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_attributes_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_object_id/patch.pyi new file mode 100644 index 000000000..0f0dd496f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_object_id/patch.pyi @@ -0,0 +1,564 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_attribute_patch_document import JsonApiAttributePatchDocument +from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DATASETS(cls): + return cls("datasets") + + @schemas.classproperty + def LABELS(cls): + return cls("labels") + + @schemas.classproperty + def ATTRIBUTE_HIERARCHIES(cls): + return cls("attributeHierarchies") + + @schemas.classproperty + def DATASET(cls): + return cls("dataset") + + @schemas.classproperty + def DEFAULT_VIEW(cls): + return cls("defaultView") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiAttributePatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiAttributePatchDocument + + +request_body_json_api_attribute_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAttributeOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAttributeOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch an Attribute (beta) + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_attribute_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityAttributes(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_attributes_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_attributes_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_search/__init__.py new file mode 100644 index 000000000..0ee68cabf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_attributes_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_ATTRIBUTES_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_search/post.py new file mode 100644 index 000000000..cb4b7b807 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAttributeOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAttributeOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for Attribute + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesAttributes(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_attributes_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_attributes_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_search/post.pyi new file mode 100644 index 000000000..ac597e25a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_attributes_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAttributeOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAttributeOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_attributes_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for Attribute + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesAttributes(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_attributes( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_attributes_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_attributes_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automation_results_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automation_results_search/__init__.py new file mode 100644 index 000000000..7b8fceaf4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automation_results_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automation_results_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_AUTOMATION_RESULTS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automation_results_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automation_results_search/post.py new file mode 100644 index 000000000..77b303fbe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automation_results_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_automation_result_out_list import JsonApiAutomationResultOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAutomationResultOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAutomationResultOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_automation_results_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_automation_results_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_automation_results_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_automation_results_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_automation_results_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for AutomationResult + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesAutomationResults(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_automation_results( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_automation_results( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_automation_results( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_automation_results( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_automation_results( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_automation_results_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_automation_results_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automation_results_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automation_results_search/post.pyi new file mode 100644 index 000000000..5c58497b1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automation_results_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_automation_result_out_list import JsonApiAutomationResultOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAutomationResultOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAutomationResultOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_automation_results_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_automation_results_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_automation_results_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_automation_results_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_automation_results_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for AutomationResult + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesAutomationResults(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_automation_results( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_automation_results( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_automation_results( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_automation_results( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_automation_results( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_automation_results_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_automation_results_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations/__init__.py new file mode 100644 index 000000000..ce7a9b811 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_AUTOMATIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations/get.py new file mode 100644 index 000000000..babb9109f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations/get.py @@ -0,0 +1,644 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "notificationChannels": "NOTIFICATION_CHANNELS", + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "userIdentifiers": "USER_IDENTIFIERS", + "exportDefinitions": "EXPORT_DEFINITIONS", + "users": "USERS", + "automationResults": "AUTOMATION_RESULTS", + "notificationChannel": "NOTIFICATION_CHANNEL", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "recipients": "RECIPIENTS", + "ALL": "ALL", + } + + @schemas.classproperty + def NOTIFICATION_CHANNELS(cls): + return cls("notificationChannels") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def EXPORT_DEFINITIONS(cls): + return cls("exportDefinitions") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def AUTOMATION_RESULTS(cls): + return cls("automationResults") + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def RECIPIENTS(cls): + return cls("recipients") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAutomationOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAutomationOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_automations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all Automations + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + request_query_filter, + request_query_include, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_automations( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_automations_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_automations_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations/get.pyi new file mode 100644 index 000000000..9c5f19aae --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations/get.pyi @@ -0,0 +1,604 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NOTIFICATION_CHANNELS(cls): + return cls("notificationChannels") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def EXPORT_DEFINITIONS(cls): + return cls("exportDefinitions") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def AUTOMATION_RESULTS(cls): + return cls("automationResults") + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def RECIPIENTS(cls): + return cls("recipients") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAutomationOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAutomationOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_automations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all Automations + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + request_query_filter, + request_query_include, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_automations( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_automations_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_automations_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations/post.py new file mode 100644 index 000000000..1c79cdfb2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations/post.py @@ -0,0 +1,648 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument + +from . import path + +# Query params + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "notificationChannels": "NOTIFICATION_CHANNELS", + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "userIdentifiers": "USER_IDENTIFIERS", + "exportDefinitions": "EXPORT_DEFINITIONS", + "users": "USERS", + "automationResults": "AUTOMATION_RESULTS", + "notificationChannel": "NOTIFICATION_CHANNEL", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "recipients": "RECIPIENTS", + "ALL": "ALL", + } + + @schemas.classproperty + def NOTIFICATION_CHANNELS(cls): + return cls("notificationChannels") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def EXPORT_DEFINITIONS(cls): + return cls("exportDefinitions") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def AUTOMATION_RESULTS(cls): + return cls("automationResults") + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def RECIPIENTS(cls): + return cls("recipients") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiAutomationInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiAutomationInDocument + + +request_body_json_api_automation_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiAutomationOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiAutomationOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Automations + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_automation_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_automations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_automations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations/post.pyi new file mode 100644 index 000000000..6d8771b40 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations/post.pyi @@ -0,0 +1,617 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument + +# Query params + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NOTIFICATION_CHANNELS(cls): + return cls("notificationChannels") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def EXPORT_DEFINITIONS(cls): + return cls("exportDefinitions") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def AUTOMATION_RESULTS(cls): + return cls("automationResults") + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def RECIPIENTS(cls): + return cls("recipients") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiAutomationInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiAutomationInDocument + + +request_body_json_api_automation_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiAutomationOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiAutomationOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Automations + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_automation_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_automations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_automations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/__init__.py new file mode 100644 index 000000000..4da5b628f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations_object_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_AUTOMATIONS_OBJECT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/delete.py new file mode 100644 index 000000000..7f5dc75b9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/delete.py @@ -0,0 +1,323 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_automations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete an Automation + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_automations( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_automations_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_automations_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/delete.pyi new file mode 100644 index 000000000..32eae863a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/delete.pyi @@ -0,0 +1,318 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_automations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete an Automation + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_automations( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_automations_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_automations_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/get.py new file mode 100644 index 000000000..9f36686f7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/get.py @@ -0,0 +1,565 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "notificationChannels": "NOTIFICATION_CHANNELS", + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "userIdentifiers": "USER_IDENTIFIERS", + "exportDefinitions": "EXPORT_DEFINITIONS", + "users": "USERS", + "automationResults": "AUTOMATION_RESULTS", + "notificationChannel": "NOTIFICATION_CHANNEL", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "recipients": "RECIPIENTS", + "ALL": "ALL", + } + + @schemas.classproperty + def NOTIFICATION_CHANNELS(cls): + return cls("notificationChannels") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def EXPORT_DEFINITIONS(cls): + return cls("exportDefinitions") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def AUTOMATION_RESULTS(cls): + return cls("automationResults") + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def RECIPIENTS(cls): + return cls("recipients") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAutomationOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAutomationOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_automations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get an Automation + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_automations( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_automations_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_automations_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/get.pyi new file mode 100644 index 000000000..4ba9c9c8c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/get.pyi @@ -0,0 +1,534 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NOTIFICATION_CHANNELS(cls): + return cls("notificationChannels") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def EXPORT_DEFINITIONS(cls): + return cls("exportDefinitions") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def AUTOMATION_RESULTS(cls): + return cls("automationResults") + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def RECIPIENTS(cls): + return cls("recipients") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAutomationOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAutomationOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_automations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get an Automation + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_automations( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_automations_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_automations_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/patch.py new file mode 100644 index 000000000..f1d9bec8b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/patch.py @@ -0,0 +1,610 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "notificationChannels": "NOTIFICATION_CHANNELS", + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "userIdentifiers": "USER_IDENTIFIERS", + "exportDefinitions": "EXPORT_DEFINITIONS", + "users": "USERS", + "automationResults": "AUTOMATION_RESULTS", + "notificationChannel": "NOTIFICATION_CHANNEL", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "recipients": "RECIPIENTS", + "ALL": "ALL", + } + + @schemas.classproperty + def NOTIFICATION_CHANNELS(cls): + return cls("notificationChannels") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def EXPORT_DEFINITIONS(cls): + return cls("exportDefinitions") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def AUTOMATION_RESULTS(cls): + return cls("automationResults") + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def RECIPIENTS(cls): + return cls("recipients") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiAutomationPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiAutomationPatchDocument + + +request_body_json_api_automation_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAutomationOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAutomationOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch an Automation + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_automation_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_automations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_automations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/patch.pyi new file mode 100644 index 000000000..f0c6b0091 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/patch.pyi @@ -0,0 +1,588 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NOTIFICATION_CHANNELS(cls): + return cls("notificationChannels") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def EXPORT_DEFINITIONS(cls): + return cls("exportDefinitions") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def AUTOMATION_RESULTS(cls): + return cls("automationResults") + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def RECIPIENTS(cls): + return cls("recipients") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiAutomationPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiAutomationPatchDocument + + +request_body_json_api_automation_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAutomationOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAutomationOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch an Automation + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_automation_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_automations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_automations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/put.py new file mode 100644 index 000000000..d2b5d8dd9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/put.py @@ -0,0 +1,610 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "notificationChannels": "NOTIFICATION_CHANNELS", + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "userIdentifiers": "USER_IDENTIFIERS", + "exportDefinitions": "EXPORT_DEFINITIONS", + "users": "USERS", + "automationResults": "AUTOMATION_RESULTS", + "notificationChannel": "NOTIFICATION_CHANNEL", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "recipients": "RECIPIENTS", + "ALL": "ALL", + } + + @schemas.classproperty + def NOTIFICATION_CHANNELS(cls): + return cls("notificationChannels") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def EXPORT_DEFINITIONS(cls): + return cls("exportDefinitions") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def AUTOMATION_RESULTS(cls): + return cls("automationResults") + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def RECIPIENTS(cls): + return cls("recipients") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiAutomationInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiAutomationInDocument + + +request_body_json_api_automation_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAutomationOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAutomationOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Put an Automation + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_automation_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_automations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_automations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/put.pyi new file mode 100644 index 000000000..c1c5099e8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_object_id/put.pyi @@ -0,0 +1,588 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument +from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def NOTIFICATION_CHANNELS(cls): + return cls("notificationChannels") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def EXPORT_DEFINITIONS(cls): + return cls("exportDefinitions") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def AUTOMATION_RESULTS(cls): + return cls("automationResults") + + @schemas.classproperty + def NOTIFICATION_CHANNEL(cls): + return cls("notificationChannel") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def RECIPIENTS(cls): + return cls("recipients") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiAutomationInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiAutomationInDocument + + +request_body_json_api_automation_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAutomationOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAutomationOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Put an Automation + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_automation_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_automations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_automations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_search/__init__.py new file mode 100644 index 000000000..b442eaff4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_automations_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_AUTOMATIONS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_search/post.py new file mode 100644 index 000000000..093d1a19e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAutomationOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAutomationOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for Automation + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_automations_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_automations_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_search/post.pyi new file mode 100644 index 000000000..5f4ffb1dd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_automations_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiAutomationOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiAutomationOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for Automation + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_automations_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_automations_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_search/__init__.py new file mode 100644 index 000000000..785ccca75 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_custom_application_settings_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_CUSTOM_APPLICATION_SETTINGS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_search/post.py new file mode 100644 index 000000000..ff467bb55 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiCustomApplicationSettingOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiCustomApplicationSettingOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_custom_application_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_custom_application_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_custom_application_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_custom_application_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_custom_application_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for CustomApplicationSetting + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesCustomApplicationSettings(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_custom_application_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_custom_application_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_custom_application_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_custom_application_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_custom_application_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_custom_application_settings_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_custom_application_settings_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_search/post.pyi new file mode 100644 index 000000000..fdd73f355 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_custom_application_settings_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiCustomApplicationSettingOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiCustomApplicationSettingOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_custom_application_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_custom_application_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_custom_application_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_custom_application_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_custom_application_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for CustomApplicationSetting + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesCustomApplicationSettings(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_custom_application_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_custom_application_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_custom_application_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_custom_application_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_custom_application_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_custom_application_settings_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_custom_application_settings_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_search/__init__.py new file mode 100644 index 000000000..1f932691d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_dashboard_plugins_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_DASHBOARD_PLUGINS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_search/post.py new file mode 100644 index 000000000..2cdeec794 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiDashboardPluginOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiDashboardPluginOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_dashboard_plugins_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_dashboard_plugins_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_dashboard_plugins_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_dashboard_plugins_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_dashboard_plugins_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for DashboardPlugin + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesDashboardPlugins(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_dashboard_plugins( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_dashboard_plugins( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_dashboard_plugins( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_dashboard_plugins( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_dashboard_plugins( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_dashboard_plugins_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_dashboard_plugins_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_search/post.pyi new file mode 100644 index 000000000..089290769 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_dashboard_plugins_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiDashboardPluginOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiDashboardPluginOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_dashboard_plugins_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_dashboard_plugins_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_dashboard_plugins_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_dashboard_plugins_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_dashboard_plugins_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for DashboardPlugin + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesDashboardPlugins(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_dashboard_plugins( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_dashboard_plugins( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_dashboard_plugins( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_dashboard_plugins( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_dashboard_plugins( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_dashboard_plugins_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_dashboard_plugins_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_object_id/patch.py new file mode 100644 index 000000000..526aef49f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_object_id/patch.py @@ -0,0 +1,585 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "attributes": "ATTRIBUTES", + "facts": "FACTS", + "aggregatedFacts": "AGGREGATED_FACTS", + "datasets": "DATASETS", + "workspaceDataFilters": "WORKSPACE_DATA_FILTERS", + "references": "REFERENCES", + "ALL": "ALL", + } + + @schemas.classproperty + def ATTRIBUTES(cls): + return cls("attributes") + + @schemas.classproperty + def FACTS(cls): + return cls("facts") + + @schemas.classproperty + def AGGREGATED_FACTS(cls): + return cls("aggregatedFacts") + + @schemas.classproperty + def DATASETS(cls): + return cls("datasets") + + @schemas.classproperty + def WORKSPACE_DATA_FILTERS(cls): + return cls("workspaceDataFilters") + + @schemas.classproperty + def REFERENCES(cls): + return cls("references") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiDatasetPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiDatasetPatchDocument + + +request_body_json_api_dataset_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiDatasetOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiDatasetOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch a Dataset (beta) + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_dataset_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityDatasets(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_datasets_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_datasets_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_object_id/patch.pyi new file mode 100644 index 000000000..00fbcde3f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_object_id/patch.pyi @@ -0,0 +1,568 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.model.json_api_dataset_patch_document import JsonApiDatasetPatchDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ATTRIBUTES(cls): + return cls("attributes") + + @schemas.classproperty + def FACTS(cls): + return cls("facts") + + @schemas.classproperty + def AGGREGATED_FACTS(cls): + return cls("aggregatedFacts") + + @schemas.classproperty + def DATASETS(cls): + return cls("datasets") + + @schemas.classproperty + def WORKSPACE_DATA_FILTERS(cls): + return cls("workspaceDataFilters") + + @schemas.classproperty + def REFERENCES(cls): + return cls("references") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiDatasetPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiDatasetPatchDocument + + +request_body_json_api_dataset_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiDatasetOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiDatasetOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch a Dataset (beta) + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_dataset_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityDatasets(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_datasets_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_datasets_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_search/__init__.py new file mode 100644 index 000000000..8237ca412 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_datasets_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_DATASETS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_search/post.py new file mode 100644 index 000000000..d30d793d0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiDatasetOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiDatasetOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for Dataset + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesDatasets(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_datasets_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_datasets_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_search/post.pyi new file mode 100644 index 000000000..dc8743377 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_datasets_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiDatasetOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiDatasetOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_datasets_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for Dataset + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesDatasets(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_datasets( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_datasets_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_datasets_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions/__init__.py new file mode 100644 index 000000000..fcfeeef27 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_EXPORT_DEFINITIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions/get.py new file mode 100644 index 000000000..a6f1aa386 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions/get.py @@ -0,0 +1,634 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "visualizationObjects": "VISUALIZATION_OBJECTS", + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "automations": "AUTOMATIONS", + "userIdentifiers": "USER_IDENTIFIERS", + "visualizationObject": "VISUALIZATION_OBJECT", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "automation": "AUTOMATION", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "ALL": "ALL", + } + + @schemas.classproperty + def VISUALIZATION_OBJECTS(cls): + return cls("visualizationObjects") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def AUTOMATIONS(cls): + return cls("automations") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def VISUALIZATION_OBJECT(cls): + return cls("visualizationObject") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def AUTOMATION(cls): + return cls("automation") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportDefinitionOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportDefinitionOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_export_definitions_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all Export Definitions + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + request_query_filter, + request_query_include, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesExportDefinitions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_export_definitions( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_export_definitions_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_export_definitions_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions/get.pyi new file mode 100644 index 000000000..8c5568539 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions/get.pyi @@ -0,0 +1,596 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def VISUALIZATION_OBJECTS(cls): + return cls("visualizationObjects") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def AUTOMATIONS(cls): + return cls("automations") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def VISUALIZATION_OBJECT(cls): + return cls("visualizationObject") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def AUTOMATION(cls): + return cls("automation") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportDefinitionOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportDefinitionOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_export_definitions_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all Export Definitions + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + request_query_filter, + request_query_include, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesExportDefinitions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_export_definitions( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_export_definitions_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_export_definitions_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions/post.py new file mode 100644 index 000000000..3ed9564fd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions/post.py @@ -0,0 +1,638 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument + +from . import path + +# Query params + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "visualizationObjects": "VISUALIZATION_OBJECTS", + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "automations": "AUTOMATIONS", + "userIdentifiers": "USER_IDENTIFIERS", + "visualizationObject": "VISUALIZATION_OBJECT", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "automation": "AUTOMATION", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "ALL": "ALL", + } + + @schemas.classproperty + def VISUALIZATION_OBJECTS(cls): + return cls("visualizationObjects") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def AUTOMATIONS(cls): + return cls("automations") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def VISUALIZATION_OBJECT(cls): + return cls("visualizationObject") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def AUTOMATION(cls): + return cls("automation") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiExportDefinitionPostOptionalIdDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiExportDefinitionPostOptionalIdDocument + + +request_body_json_api_export_definition_post_optional_id_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiExportDefinitionOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiExportDefinitionOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Export Definitions + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_export_definition_post_optional_id_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityExportDefinitions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_export_definitions_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_export_definitions_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions/post.pyi new file mode 100644 index 000000000..4757368df --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions/post.pyi @@ -0,0 +1,609 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.model.json_api_export_definition_post_optional_id_document import JsonApiExportDefinitionPostOptionalIdDocument + +# Query params + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def VISUALIZATION_OBJECTS(cls): + return cls("visualizationObjects") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def AUTOMATIONS(cls): + return cls("automations") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def VISUALIZATION_OBJECT(cls): + return cls("visualizationObject") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def AUTOMATION(cls): + return cls("automation") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiExportDefinitionPostOptionalIdDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiExportDefinitionPostOptionalIdDocument + + +request_body_json_api_export_definition_post_optional_id_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiExportDefinitionOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiExportDefinitionOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Export Definitions + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_export_definition_post_optional_id_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityExportDefinitions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_export_definitions_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_export_definitions_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/__init__.py new file mode 100644 index 000000000..c03f2e254 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions_object_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_EXPORT_DEFINITIONS_OBJECT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/delete.py new file mode 100644 index 000000000..a32883121 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/delete.py @@ -0,0 +1,323 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_export_definitions_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete an Export Definition + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityExportDefinitions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_export_definitions( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_export_definitions_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_export_definitions_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/delete.pyi new file mode 100644 index 000000000..17650ed45 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/delete.pyi @@ -0,0 +1,318 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_export_definitions_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete an Export Definition + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityExportDefinitions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_export_definitions( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_export_definitions_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_export_definitions_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/get.py new file mode 100644 index 000000000..23854a154 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/get.py @@ -0,0 +1,555 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "visualizationObjects": "VISUALIZATION_OBJECTS", + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "automations": "AUTOMATIONS", + "userIdentifiers": "USER_IDENTIFIERS", + "visualizationObject": "VISUALIZATION_OBJECT", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "automation": "AUTOMATION", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "ALL": "ALL", + } + + @schemas.classproperty + def VISUALIZATION_OBJECTS(cls): + return cls("visualizationObjects") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def AUTOMATIONS(cls): + return cls("automations") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def VISUALIZATION_OBJECT(cls): + return cls("visualizationObject") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def AUTOMATION(cls): + return cls("automation") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportDefinitionOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportDefinitionOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_export_definitions_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get an Export Definition + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityExportDefinitions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_export_definitions( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_export_definitions_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_export_definitions_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/get.pyi new file mode 100644 index 000000000..dabe69319 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/get.pyi @@ -0,0 +1,526 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def VISUALIZATION_OBJECTS(cls): + return cls("visualizationObjects") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def AUTOMATIONS(cls): + return cls("automations") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def VISUALIZATION_OBJECT(cls): + return cls("visualizationObject") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def AUTOMATION(cls): + return cls("automation") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportDefinitionOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportDefinitionOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_export_definitions_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_export_definitions_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get an Export Definition + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityExportDefinitions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_export_definitions( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_export_definitions( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_export_definitions_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_export_definitions_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/patch.py new file mode 100644 index 000000000..4277721f0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/patch.py @@ -0,0 +1,600 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "visualizationObjects": "VISUALIZATION_OBJECTS", + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "automations": "AUTOMATIONS", + "userIdentifiers": "USER_IDENTIFIERS", + "visualizationObject": "VISUALIZATION_OBJECT", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "automation": "AUTOMATION", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "ALL": "ALL", + } + + @schemas.classproperty + def VISUALIZATION_OBJECTS(cls): + return cls("visualizationObjects") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def AUTOMATIONS(cls): + return cls("automations") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def VISUALIZATION_OBJECT(cls): + return cls("visualizationObject") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def AUTOMATION(cls): + return cls("automation") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiExportDefinitionPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiExportDefinitionPatchDocument + + +request_body_json_api_export_definition_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportDefinitionOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportDefinitionOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch an Export Definition + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_export_definition_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityExportDefinitions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_export_definitions_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_export_definitions_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/patch.pyi new file mode 100644 index 000000000..1be3ece0c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/patch.pyi @@ -0,0 +1,580 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def VISUALIZATION_OBJECTS(cls): + return cls("visualizationObjects") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def AUTOMATIONS(cls): + return cls("automations") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def VISUALIZATION_OBJECT(cls): + return cls("visualizationObject") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def AUTOMATION(cls): + return cls("automation") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiExportDefinitionPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiExportDefinitionPatchDocument + + +request_body_json_api_export_definition_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportDefinitionOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportDefinitionOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch an Export Definition + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_export_definition_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityExportDefinitions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_export_definitions_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_export_definitions_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/put.py new file mode 100644 index 000000000..0ab1a532c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/put.py @@ -0,0 +1,600 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.model.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "visualizationObjects": "VISUALIZATION_OBJECTS", + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "automations": "AUTOMATIONS", + "userIdentifiers": "USER_IDENTIFIERS", + "visualizationObject": "VISUALIZATION_OBJECT", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "automation": "AUTOMATION", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "ALL": "ALL", + } + + @schemas.classproperty + def VISUALIZATION_OBJECTS(cls): + return cls("visualizationObjects") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def AUTOMATIONS(cls): + return cls("automations") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def VISUALIZATION_OBJECT(cls): + return cls("visualizationObject") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def AUTOMATION(cls): + return cls("automation") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiExportDefinitionInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiExportDefinitionInDocument + + +request_body_json_api_export_definition_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportDefinitionOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportDefinitionOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Put an Export Definition + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_export_definition_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityExportDefinitions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_export_definitions_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_export_definitions_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/put.pyi new file mode 100644 index 000000000..2a6b1ae6e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_object_id/put.pyi @@ -0,0 +1,580 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.model.json_api_export_definition_in_document import JsonApiExportDefinitionInDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def VISUALIZATION_OBJECTS(cls): + return cls("visualizationObjects") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def AUTOMATIONS(cls): + return cls("automations") + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def VISUALIZATION_OBJECT(cls): + return cls("visualizationObject") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def AUTOMATION(cls): + return cls("automation") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiExportDefinitionInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiExportDefinitionInDocument + + +request_body_json_api_export_definition_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportDefinitionOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportDefinitionOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Put an Export Definition + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_export_definition_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityExportDefinitions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_export_definitions_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_export_definitions_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_search/__init__.py new file mode 100644 index 000000000..651b0b2d8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_export_definitions_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_EXPORT_DEFINITIONS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_search/post.py new file mode 100644 index 000000000..5bbb58003 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportDefinitionOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportDefinitionOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for ExportDefinition + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesExportDefinitions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_export_definitions_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_export_definitions_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_search/post.pyi new file mode 100644 index 000000000..addc1f8dd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_export_definitions_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiExportDefinitionOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiExportDefinitionOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_export_definitions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for ExportDefinition + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesExportDefinitions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_export_definitions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_export_definitions_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_export_definitions_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_object_id/patch.py new file mode 100644 index 000000000..d5f892958 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_object_id/patch.py @@ -0,0 +1,565 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "datasets": "DATASETS", + "dataset": "DATASET", + "ALL": "ALL", + } + + @schemas.classproperty + def DATASETS(cls): + return cls("datasets") + + @schemas.classproperty + def DATASET(cls): + return cls("dataset") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiFactPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiFactPatchDocument + + +request_body_json_api_fact_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiFactOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiFactOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch a Fact (beta) + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_fact_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityFacts(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_facts_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_facts_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_object_id/patch.pyi new file mode 100644 index 000000000..31b079340 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_object_id/patch.pyi @@ -0,0 +1,552 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.model.json_api_fact_patch_document import JsonApiFactPatchDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def DATASETS(cls): + return cls("datasets") + + @schemas.classproperty + def DATASET(cls): + return cls("dataset") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiFactPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiFactPatchDocument + + +request_body_json_api_fact_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiFactOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiFactOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch a Fact (beta) + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_fact_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityFacts(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_facts_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_facts_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_search/__init__.py new file mode 100644 index 000000000..59c6148c3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_facts_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_FACTS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_search/post.py new file mode 100644 index 000000000..8942bb7f0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiFactOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiFactOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for Fact + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesFacts(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_facts_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_facts_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_search/post.pyi new file mode 100644 index 000000000..ad04b0e88 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_facts_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiFactOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiFactOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_facts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for Fact + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesFacts(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_facts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_facts_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_facts_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_search/__init__.py new file mode 100644 index 000000000..6d85908cf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_contexts_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_FILTER_CONTEXTS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_search/post.py new file mode 100644 index 000000000..a3a5fa690 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiFilterContextOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiFilterContextOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_filter_contexts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_filter_contexts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_filter_contexts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_filter_contexts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_filter_contexts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for FilterContext + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesFilterContexts(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_filter_contexts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_filter_contexts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_filter_contexts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_filter_contexts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_filter_contexts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_filter_contexts_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_filter_contexts_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_search/post.pyi new file mode 100644 index 000000000..6f20d8ce3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_contexts_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiFilterContextOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiFilterContextOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_filter_contexts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_filter_contexts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_filter_contexts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_filter_contexts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_filter_contexts_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for FilterContext + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesFilterContexts(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_filter_contexts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_filter_contexts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_filter_contexts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_filter_contexts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_filter_contexts( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_filter_contexts_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_filter_contexts_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views/__init__.py new file mode 100644 index 000000000..6eea8625e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_FILTER_VIEWS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views/get.py new file mode 100644 index 000000000..5bfc96206 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views/get.py @@ -0,0 +1,604 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "users": "USERS", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "user": "USER", + "ALL": "ALL", + } + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def USER(cls): + return cls("user") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiFilterViewOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiFilterViewOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_filter_views_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all Filter views + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + request_query_filter, + request_query_include, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_filter_views( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_filter_views_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_filter_views_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views/get.pyi new file mode 100644 index 000000000..24800eebe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views/get.pyi @@ -0,0 +1,572 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def USER(cls): + return cls("user") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiFilterViewOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiFilterViewOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_filter_views_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all Filter views + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + request_query_filter, + request_query_include, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_filter_views( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_filter_views_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_filter_views_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views/post.py new file mode 100644 index 000000000..fc596dfdc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views/post.py @@ -0,0 +1,557 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument + +from . import path + +# Query params + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "users": "USERS", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "user": "USER", + "ALL": "ALL", + } + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def USER(cls): + return cls("user") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiFilterViewInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiFilterViewInDocument + + +request_body_json_api_filter_view_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiFilterViewOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiFilterViewOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Filter views + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_filter_view_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_filter_views_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_filter_views_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views/post.pyi new file mode 100644 index 000000000..fe3742b48 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views/post.pyi @@ -0,0 +1,542 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument + +# Query params + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def USER(cls): + return cls("user") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiFilterViewInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiFilterViewInDocument + + +request_body_json_api_filter_view_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiFilterViewOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiFilterViewOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Filter views + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_filter_view_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_filter_views_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_filter_views_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/__init__.py new file mode 100644 index 000000000..a0dd440a7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views_object_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_FILTER_VIEWS_OBJECT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/delete.py new file mode 100644 index 000000000..ac3da5c73 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/delete.py @@ -0,0 +1,323 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_filter_views_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete Filter view + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_filter_views( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_filter_views_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_filter_views_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/delete.pyi new file mode 100644 index 000000000..87750e6fa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/delete.pyi @@ -0,0 +1,318 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_filter_views_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete Filter view + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_filter_views( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_filter_views_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_filter_views_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/get.py new file mode 100644 index 000000000..10a8fd3fb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/get.py @@ -0,0 +1,474 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "users": "USERS", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "user": "USER", + "ALL": "ALL", + } + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def USER(cls): + return cls("user") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiFilterViewOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiFilterViewOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_filter_views_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Filter view + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_filter_views( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_filter_views_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_filter_views_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/get.pyi new file mode 100644 index 000000000..0eaed772d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/get.pyi @@ -0,0 +1,459 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def USER(cls): + return cls("user") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiFilterViewOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiFilterViewOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_filter_views_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get Filter view + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_filter_views( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_filter_views_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_filter_views_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/patch.py new file mode 100644 index 000000000..eef2a5791 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/patch.py @@ -0,0 +1,575 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "users": "USERS", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "user": "USER", + "ALL": "ALL", + } + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def USER(cls): + return cls("user") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiFilterViewPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiFilterViewPatchDocument + + +request_body_json_api_filter_view_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiFilterViewOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiFilterViewOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch Filter view + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_filter_view_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_filter_views_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_filter_views_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/patch.pyi new file mode 100644 index 000000000..daefb2677 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/patch.pyi @@ -0,0 +1,560 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def USER(cls): + return cls("user") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiFilterViewPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiFilterViewPatchDocument + + +request_body_json_api_filter_view_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiFilterViewOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiFilterViewOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch Filter view + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_filter_view_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_filter_views_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_filter_views_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/put.py new file mode 100644 index 000000000..eb8c158d4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/put.py @@ -0,0 +1,575 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "users": "USERS", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "user": "USER", + "ALL": "ALL", + } + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def USER(cls): + return cls("user") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiFilterViewInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiFilterViewInDocument + + +request_body_json_api_filter_view_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiFilterViewOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiFilterViewOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Put Filter views + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_filter_view_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_filter_views_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_filter_views_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/put.pyi new file mode 100644 index 000000000..4693467ec --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_object_id/put.pyi @@ -0,0 +1,560 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument +from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def USERS(cls): + return cls("users") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def USER(cls): + return cls("user") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiFilterViewInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiFilterViewInDocument + + +request_body_json_api_filter_view_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiFilterViewOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiFilterViewOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Put Filter views + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_filter_view_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_filter_views_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_filter_views_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_search/__init__.py new file mode 100644 index 000000000..e5b19b4b5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_filter_views_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_FILTER_VIEWS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_search/post.py new file mode 100644 index 000000000..4f57a1443 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiFilterViewOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiFilterViewOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for FilterView + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_filter_views_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_filter_views_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_search/post.pyi new file mode 100644 index 000000000..c3ca2ea12 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_filter_views_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiFilterViewOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiFilterViewOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for FilterView + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_filter_views_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_filter_views_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations/__init__.py new file mode 100644 index 000000000..11f05e568 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_KNOWLEDGE_RECOMMENDATIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations/get.py new file mode 100644 index 000000000..f2fcea034 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations/get.py @@ -0,0 +1,608 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "metrics": "METRICS", + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "metric": "METRIC", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "ALL": "ALL", + } + + @schemas.classproperty + def METRICS(cls): + return cls("metrics") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiKnowledgeRecommendationOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_knowledge_recommendations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + request_query_filter, + request_query_include, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesKnowledgeRecommendations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_knowledge_recommendations( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_knowledge_recommendations_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_knowledge_recommendations_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations/get.pyi new file mode 100644 index 000000000..d16959f9b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations/get.pyi @@ -0,0 +1,575 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def METRICS(cls): + return cls("metrics") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiKnowledgeRecommendationOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_knowledge_recommendations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + request_query_filter, + request_query_include, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesKnowledgeRecommendations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_knowledge_recommendations( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_knowledge_recommendations_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_knowledge_recommendations_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations/post.py new file mode 100644 index 000000000..a1b3136ed --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations/post.py @@ -0,0 +1,612 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "metrics": "METRICS", + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "metric": "METRIC", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "ALL": "ALL", + } + + @schemas.classproperty + def METRICS(cls): + return cls("metrics") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiKnowledgeRecommendationPostOptionalIdDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationPostOptionalIdDocument + + +request_body_json_api_knowledge_recommendation_post_optional_id_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiKnowledgeRecommendationOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_knowledge_recommendation_post_optional_id_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityKnowledgeRecommendations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_knowledge_recommendations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_knowledge_recommendations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations/post.pyi new file mode 100644 index 000000000..28624efff --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations/post.pyi @@ -0,0 +1,588 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 + +# Query params + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def METRICS(cls): + return cls("metrics") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiKnowledgeRecommendationPostOptionalIdDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationPostOptionalIdDocument + + +request_body_json_api_knowledge_recommendation_post_optional_id_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiKnowledgeRecommendationOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_knowledge_recommendation_post_optional_id_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityKnowledgeRecommendations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_knowledge_recommendations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_knowledge_recommendations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/__init__.py new file mode 100644 index 000000000..c862c615f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_KNOWLEDGE_RECOMMENDATIONS_OBJECT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/delete.py new file mode 100644 index 000000000..74130669b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/delete.py @@ -0,0 +1,322 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_knowledge_recommendations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityKnowledgeRecommendations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_knowledge_recommendations( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_knowledge_recommendations_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_knowledge_recommendations_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/delete.pyi new file mode 100644 index 000000000..c0f31f4b4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/delete.pyi @@ -0,0 +1,317 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_knowledge_recommendations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityKnowledgeRecommendations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_knowledge_recommendations( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_knowledge_recommendations_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_knowledge_recommendations_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/get.py new file mode 100644 index 000000000..83e553648 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/get.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "metrics": "METRICS", + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "metric": "METRIC", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "ALL": "ALL", + } + + @schemas.classproperty + def METRICS(cls): + return cls("metrics") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiKnowledgeRecommendationOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_knowledge_recommendations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityKnowledgeRecommendations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_knowledge_recommendations( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_knowledge_recommendations_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_knowledge_recommendations_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/get.pyi new file mode 100644 index 000000000..dec36c826 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/get.pyi @@ -0,0 +1,505 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def METRICS(cls): + return cls("metrics") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiKnowledgeRecommendationOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_knowledge_recommendations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_knowledge_recommendations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityKnowledgeRecommendations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_knowledge_recommendations( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_knowledge_recommendations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_knowledge_recommendations_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_knowledge_recommendations_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/patch.py new file mode 100644 index 000000000..a301b453a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/patch.py @@ -0,0 +1,574 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "metrics": "METRICS", + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "metric": "METRIC", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "ALL": "ALL", + } + + @schemas.classproperty + def METRICS(cls): + return cls("metrics") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiKnowledgeRecommendationPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationPatchDocument + + +request_body_json_api_knowledge_recommendation_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiKnowledgeRecommendationOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_knowledge_recommendation_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityKnowledgeRecommendations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_knowledge_recommendations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_knowledge_recommendations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/patch.pyi new file mode 100644 index 000000000..129229322 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/patch.pyi @@ -0,0 +1,559 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def METRICS(cls): + return cls("metrics") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiKnowledgeRecommendationPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationPatchDocument + + +request_body_json_api_knowledge_recommendation_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiKnowledgeRecommendationOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_knowledge_recommendation_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityKnowledgeRecommendations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_knowledge_recommendations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_knowledge_recommendations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/put.py new file mode 100644 index 000000000..2f51327f0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/put.py @@ -0,0 +1,574 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "metrics": "METRICS", + "analyticalDashboards": "ANALYTICAL_DASHBOARDS", + "metric": "METRIC", + "analyticalDashboard": "ANALYTICAL_DASHBOARD", + "ALL": "ALL", + } + + @schemas.classproperty + def METRICS(cls): + return cls("metrics") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiKnowledgeRecommendationInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationInDocument + + +request_body_json_api_knowledge_recommendation_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiKnowledgeRecommendationOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_knowledge_recommendation_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityKnowledgeRecommendations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_knowledge_recommendations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_knowledge_recommendations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/put.pyi new file mode 100644 index 000000000..1d42e9289 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_object_id/put.pyi @@ -0,0 +1,559 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def METRICS(cls): + return cls("metrics") + + @schemas.classproperty + def ANALYTICAL_DASHBOARDS(cls): + return cls("analyticalDashboards") + + @schemas.classproperty + def METRIC(cls): + return cls("metric") + + @schemas.classproperty + def ANALYTICAL_DASHBOARD(cls): + return cls("analyticalDashboard") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiKnowledgeRecommendationInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationInDocument + + +request_body_json_api_knowledge_recommendation_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiKnowledgeRecommendationOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_knowledge_recommendation_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityKnowledgeRecommendations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_knowledge_recommendations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_knowledge_recommendations_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_search/__init__.py new file mode 100644 index 000000000..b960020dc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_knowledge_recommendations_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_KNOWLEDGE_RECOMMENDATIONS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_search/post.py new file mode 100644 index 000000000..11e19b2e2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_search/post.py @@ -0,0 +1,528 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiKnowledgeRecommendationOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesKnowledgeRecommendations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_knowledge_recommendations_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_knowledge_recommendations_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_search/post.pyi new file mode 100644 index 000000000..d67a8cec9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_knowledge_recommendations_search/post.pyi @@ -0,0 +1,515 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiKnowledgeRecommendationOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiKnowledgeRecommendationOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_knowledge_recommendations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesKnowledgeRecommendations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_knowledge_recommendations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_knowledge_recommendations_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_knowledge_recommendations_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_object_id/patch.py new file mode 100644 index 000000000..2bd85d3f4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_object_id/patch.py @@ -0,0 +1,565 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "attributes": "ATTRIBUTES", + "attribute": "ATTRIBUTE", + "ALL": "ALL", + } + + @schemas.classproperty + def ATTRIBUTES(cls): + return cls("attributes") + + @schemas.classproperty + def ATTRIBUTE(cls): + return cls("attribute") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiLabelPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiLabelPatchDocument + + +request_body_json_api_label_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLabelOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLabelOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch a Label (beta) + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_label_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityLabels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_labels_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_labels_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_object_id/patch.pyi new file mode 100644 index 000000000..4d9672fda --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_object_id/patch.pyi @@ -0,0 +1,552 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_label_patch_document import JsonApiLabelPatchDocument +from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ATTRIBUTES(cls): + return cls("attributes") + + @schemas.classproperty + def ATTRIBUTE(cls): + return cls("attribute") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiLabelPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiLabelPatchDocument + + +request_body_json_api_label_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLabelOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLabelOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch a Label (beta) + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_label_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityLabels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_labels_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_labels_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_search/__init__.py new file mode 100644 index 000000000..25a058e95 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_labels_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_LABELS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_search/post.py new file mode 100644 index 000000000..dbd22dbde --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLabelOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLabelOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for Label + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesLabels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_labels_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_labels_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_search/post.pyi new file mode 100644 index 000000000..874f32d5b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_labels_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiLabelOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiLabelOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_labels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for Label + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesLabels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_labels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_labels_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_labels_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items/__init__.py new file mode 100644 index 000000000..5d6ef6315 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_MEMORY_ITEMS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items/get.py new file mode 100644 index 000000000..700f3b5c3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items/get.py @@ -0,0 +1,603 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "userIdentifiers": "USER_IDENTIFIERS", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "ALL": "ALL", + } + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "page": "PAGE", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiMemoryItemOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiMemoryItemOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_memory_items_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + request_query_filter, + request_query_include, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesMemoryItems(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_memory_items( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_memory_items_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_memory_items_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items/get.pyi new file mode 100644 index 000000000..0329c6c91 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items/get.pyi @@ -0,0 +1,571 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +PageSchema = schemas.IntSchema +SizeSchema = schemas.IntSchema + + +class SortSchema( + schemas.ListSchema +): + + + class MetaOapg: + items = schemas.StrSchema + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SortSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def PAGE(cls): + return cls("page") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'page': typing.Union[PageSchema, decimal.Decimal, int, ], + 'size': typing.Union[SizeSchema, decimal.Decimal, int, ], + 'sort': typing.Union[SortSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_page = api_client.QueryParameter( + name="page", + style=api_client.ParameterStyle.FORM, + schema=PageSchema, + explode=True, +) +request_query_size = api_client.QueryParameter( + name="size", + style=api_client.ParameterStyle.FORM, + schema=SizeSchema, + explode=True, +) +request_query_sort = api_client.QueryParameter( + name="sort", + style=api_client.ParameterStyle.FORM, + schema=SortSchema, + explode=True, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiMemoryItemOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiMemoryItemOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_all_entities_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_all_entities_memory_items_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_all_entities_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_all_entities_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + request_query_filter, + request_query_include, + request_query_page, + request_query_size, + request_query_sort, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAllEntitiesMemoryItems(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_all_entities_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_all_entities_memory_items( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_all_entities_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_all_entities_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_memory_items_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_all_entities_memory_items_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items/post.py new file mode 100644 index 000000000..7fa5d068a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items/post.py @@ -0,0 +1,607 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "userIdentifiers": "USER_IDENTIFIERS", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "ALL": "ALL", + } + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiMemoryItemPostOptionalIdDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiMemoryItemPostOptionalIdDocument + + +request_body_json_api_memory_item_post_optional_id_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiMemoryItemOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiMemoryItemOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_memory_item_post_optional_id_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityMemoryItems(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_memory_items_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_memory_items_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items/post.pyi new file mode 100644 index 000000000..782db4768 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items/post.pyi @@ -0,0 +1,584 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 + +# Query params + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiMemoryItemPostOptionalIdDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiMemoryItemPostOptionalIdDocument + + +request_body_json_api_memory_item_post_optional_id_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiMemoryItemOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiMemoryItemOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_memory_item_post_optional_id_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityMemoryItems(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_memory_items_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_memory_items_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/__init__.py new file mode 100644 index 000000000..29353a9ce --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items_object_id import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_MEMORY_ITEMS_OBJECT_ID \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/delete.py new file mode 100644 index 000000000..9fa51e85d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/delete.py @@ -0,0 +1,322 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_memory_items_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityMemoryItems(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_memory_items( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_memory_items_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_memory_items_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/delete.pyi new file mode 100644 index 000000000..915760360 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/delete.pyi @@ -0,0 +1,317 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_memory_items_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityMemoryItems(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_memory_items( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_memory_items_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_memory_items_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/get.py new file mode 100644 index 000000000..f21242ac6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/get.py @@ -0,0 +1,524 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "userIdentifiers": "USER_IDENTIFIERS", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "ALL": "ALL", + } + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiMemoryItemOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiMemoryItemOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_memory_items_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityMemoryItems(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_memory_items( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_memory_items_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_memory_items_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/get.pyi new file mode 100644 index 000000000..b73dee286 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/get.pyi @@ -0,0 +1,501 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiMemoryItemOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiMemoryItemOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_entity_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_entity_memory_items_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_entity_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_entity_memory_items_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetEntityMemoryItems(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_entity_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_entity_memory_items( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_entity_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_entity_memory_items( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_memory_items_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_entity_memory_items_oapg( + query_params=query_params, + header_params=header_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/patch.py new file mode 100644 index 000000000..da8d09803 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/patch.py @@ -0,0 +1,569 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "userIdentifiers": "USER_IDENTIFIERS", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "ALL": "ALL", + } + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiMemoryItemPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiMemoryItemPatchDocument + + +request_body_json_api_memory_item_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiMemoryItemOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiMemoryItemOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_memory_item_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityMemoryItems(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_memory_items_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_memory_items_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/patch.pyi new file mode 100644 index 000000000..4e34e2dd0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/patch.pyi @@ -0,0 +1,555 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiMemoryItemPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiMemoryItemPatchDocument + + +request_body_json_api_memory_item_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiMemoryItemOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiMemoryItemOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_memory_item_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityMemoryItems(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_memory_items_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_memory_items_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/put.py new file mode 100644 index 000000000..001f22727 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/put.py @@ -0,0 +1,569 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "userIdentifiers": "USER_IDENTIFIERS", + "createdBy": "CREATED_BY", + "modifiedBy": "MODIFIED_BY", + "ALL": "ALL", + } + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiMemoryItemInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiMemoryItemInDocument + + +request_body_json_api_memory_item_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiMemoryItemOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiMemoryItemOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_memory_item_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityMemoryItems(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_memory_items_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_memory_items_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/put.pyi new file mode 100644 index 000000000..638095b7a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_object_id/put.pyi @@ -0,0 +1,555 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def USER_IDENTIFIERS(cls): + return cls("userIdentifiers") + + @schemas.classproperty + def CREATED_BY(cls): + return cls("createdBy") + + @schemas.classproperty + def MODIFIED_BY(cls): + return cls("modifiedBy") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiMemoryItemInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiMemoryItemInDocument + + +request_body_json_api_memory_item_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiMemoryItemOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiMemoryItemOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_memory_item_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityMemoryItems(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_memory_items_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_memory_items_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_search/__init__.py new file mode 100644 index 000000000..bcb4d3c25 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_memory_items_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_MEMORY_ITEMS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_search/post.py new file mode 100644 index 000000000..4a7dc3135 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiMemoryItemOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiMemoryItemOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for MemoryItem + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesMemoryItems(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_memory_items_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_memory_items_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_search/post.pyi new file mode 100644 index 000000000..2869d9b05 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_memory_items_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiMemoryItemOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiMemoryItemOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_memory_items_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for MemoryItem + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesMemoryItems(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_memory_items( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_memory_items_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_memory_items_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_search/__init__.py new file mode 100644 index 000000000..6be148901 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_metrics_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_METRICS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_search/post.py new file mode 100644 index 000000000..ef6e2868b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiMetricOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiMetricOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_metrics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_metrics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_metrics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_metrics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_metrics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for Metric + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesMetrics(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_metrics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_metrics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_metrics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_metrics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_metrics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_metrics_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_metrics_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_search/post.pyi new file mode 100644 index 000000000..a4677011d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_metrics_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiMetricOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiMetricOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_metrics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_metrics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_metrics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_metrics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_metrics_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for Metric + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesMetrics(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_metrics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_metrics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_metrics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_metrics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_metrics( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_metrics_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_metrics_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_search/__init__.py new file mode 100644 index 000000000..4a3bf579d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_user_data_filters_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_USER_DATA_FILTERS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_search/post.py new file mode 100644 index 000000000..741f8465e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiUserDataFilterOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiUserDataFilterOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_user_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_user_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_user_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_user_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_user_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for UserDataFilter + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesUserDataFilters(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_user_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_user_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_user_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_user_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_user_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_user_data_filters_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_user_data_filters_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_search/post.pyi new file mode 100644 index 000000000..cebca8f36 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_user_data_filters_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiUserDataFilterOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiUserDataFilterOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_user_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_user_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_user_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_user_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_user_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for UserDataFilter + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesUserDataFilters(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_user_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_user_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_user_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_user_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_user_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_user_data_filters_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_user_data_filters_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_search/__init__.py new file mode 100644 index 000000000..1be8ead83 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_visualization_objects_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_VISUALIZATION_OBJECTS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_search/post.py new file mode 100644 index 000000000..27f282743 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiVisualizationObjectOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiVisualizationObjectOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_visualization_objects_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_visualization_objects_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_visualization_objects_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_visualization_objects_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_visualization_objects_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for VisualizationObject + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesVisualizationObjects(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_visualization_objects( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_visualization_objects( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_visualization_objects( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_visualization_objects( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_visualization_objects( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_visualization_objects_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_visualization_objects_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_search/post.pyi new file mode 100644 index 000000000..b290bb476 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_visualization_objects_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiVisualizationObjectOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiVisualizationObjectOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_visualization_objects_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_visualization_objects_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_visualization_objects_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_visualization_objects_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_visualization_objects_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for VisualizationObject + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesVisualizationObjects(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_visualization_objects( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_visualization_objects( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_visualization_objects( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_visualization_objects( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_visualization_objects( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_visualization_objects_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_visualization_objects_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings/post.py new file mode 100644 index 000000000..ee91edd42 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings/post.py @@ -0,0 +1,603 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "workspaceDataFilters": "WORKSPACE_DATA_FILTERS", + "workspaceDataFilter": "WORKSPACE_DATA_FILTER", + "ALL": "ALL", + } + + @schemas.classproperty + def WORKSPACE_DATA_FILTERS(cls): + return cls("workspaceDataFilters") + + @schemas.classproperty + def WORKSPACE_DATA_FILTER(cls): + return cls("workspaceDataFilter") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + unique_items = True + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "origin": "ORIGIN", + "all": "ALL", + "ALL": "ALL", + } + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiWorkspaceDataFilterSettingInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiWorkspaceDataFilterSettingInDocument + + +request_body_json_api_workspace_data_filter_setting_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiWorkspaceDataFilterSettingOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiWorkspaceDataFilterSettingOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '201': _response_for_201, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Settings for Workspace Data Filters + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_workspace_data_filter_setting_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityWorkspaceDataFilterSettings(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_workspace_data_filter_settings_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_workspace_data_filter_settings_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings/post.pyi new file mode 100644 index 000000000..ac347d0f3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings/post.pyi @@ -0,0 +1,581 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 + +# Query params + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def WORKSPACE_DATA_FILTERS(cls): + return cls("workspaceDataFilters") + + @schemas.classproperty + def WORKSPACE_DATA_FILTER(cls): + return cls("workspaceDataFilter") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) + + +class MetaIncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ORIGIN(cls): + return cls("origin") + + @schemas.classproperty + def ALL(cls): + return cls("all") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'MetaIncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'include': typing.Union[IncludeSchema, list, tuple, ], + 'metaInclude': typing.Union[MetaIncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +request_query_meta_include = api_client.QueryParameter( + name="metaInclude", + style=api_client.ParameterStyle.FORM, + schema=MetaIncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiWorkspaceDataFilterSettingInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiWorkspaceDataFilterSettingInDocument + + +request_body_json_api_workspace_data_filter_setting_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor201ResponseBodyApplicationJson = JsonApiWorkspaceDataFilterSettingOutDocument +SchemaFor201ResponseBodyApplicationVndGooddataApijson = JsonApiWorkspaceDataFilterSettingOutDocument + + +@dataclass +class ApiResponseFor201(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor201ResponseBodyApplicationJson, + SchemaFor201ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_201 = api_client.OpenApiResponse( + response_cls=ApiResponseFor201, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor201ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _create_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def _create_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def _create_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _create_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _create_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Post Settings for Workspace Data Filters + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_include, + request_query_meta_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_workspace_data_filter_setting_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class CreateEntityWorkspaceDataFilterSettings(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def create_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def create_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def create_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def create_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def create_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_workspace_data_filter_settings_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor201, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor201, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._create_entity_workspace_data_filter_settings_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/delete.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/delete.py new file mode 100644 index 000000000..18ad27ff5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/delete.py @@ -0,0 +1,323 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from . import path + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_workspace_data_filter_settings_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_workspace_data_filter_settings_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_workspace_data_filter_settings_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_workspace_data_filter_settings_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete a Settings for Workspace Data Filter + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityWorkspaceDataFilterSettings(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_workspace_data_filter_settings( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_workspace_data_filter_settings( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_workspace_data_filter_settings( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_workspace_data_filter_settings( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_workspace_data_filter_settings_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_workspace_data_filter_settings_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/delete.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/delete.pyi new file mode 100644 index 000000000..e8a818abe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/delete.pyi @@ -0,0 +1,318 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +# Query params +FilterSchema = schemas.StrSchema +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _delete_entity_workspace_data_filter_settings_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _delete_entity_workspace_data_filter_settings_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _delete_entity_workspace_data_filter_settings_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _delete_entity_workspace_data_filter_settings_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Delete a Settings for Workspace Data Filter + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + # TODO add cookie handling + + response = self.api_client.call_api( + resource_path=used_path, + method='delete'.upper(), + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class DeleteEntityWorkspaceDataFilterSettings(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def delete_entity_workspace_data_filter_settings( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete_entity_workspace_data_filter_settings( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete_entity_workspace_data_filter_settings( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete_entity_workspace_data_filter_settings( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_workspace_data_filter_settings_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiFordelete(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def delete( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def delete( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._delete_entity_workspace_data_filter_settings_oapg( + query_params=query_params, + path_params=path_params, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/patch.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/patch.py new file mode 100644 index 000000000..262a48260 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/patch.py @@ -0,0 +1,565 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument + +from . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "workspaceDataFilters": "WORKSPACE_DATA_FILTERS", + "workspaceDataFilter": "WORKSPACE_DATA_FILTER", + "ALL": "ALL", + } + + @schemas.classproperty + def WORKSPACE_DATA_FILTERS(cls): + return cls("workspaceDataFilters") + + @schemas.classproperty + def WORKSPACE_DATA_FILTER(cls): + return cls("workspaceDataFilter") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiWorkspaceDataFilterSettingPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiWorkspaceDataFilterSettingPatchDocument + + +request_body_json_api_workspace_data_filter_setting_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiWorkspaceDataFilterSettingOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiWorkspaceDataFilterSettingOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch a Settings for Workspace Data Filter + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_workspace_data_filter_setting_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityWorkspaceDataFilterSettings(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_workspace_data_filter_settings_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_workspace_data_filter_settings_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/patch.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/patch.pyi new file mode 100644 index 000000000..3c5c6936c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/patch.pyi @@ -0,0 +1,552 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def WORKSPACE_DATA_FILTERS(cls): + return cls("workspaceDataFilters") + + @schemas.classproperty + def WORKSPACE_DATA_FILTER(cls): + return cls("workspaceDataFilter") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiWorkspaceDataFilterSettingPatchDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiWorkspaceDataFilterSettingPatchDocument + + +request_body_json_api_workspace_data_filter_setting_patch_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiWorkspaceDataFilterSettingOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiWorkspaceDataFilterSettingOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _patch_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _patch_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _patch_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _patch_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _patch_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Patch a Settings for Workspace Data Filter + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_workspace_data_filter_setting_patch_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='patch'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class PatchEntityWorkspaceDataFilterSettings(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def patch_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_workspace_data_filter_settings_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpatch(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def patch( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._patch_entity_workspace_data_filter_settings_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/put.py new file mode 100644 index 000000000..f798a00c4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/put.py @@ -0,0 +1,565 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 . import path + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "workspaceDataFilters": "WORKSPACE_DATA_FILTERS", + "workspaceDataFilter": "WORKSPACE_DATA_FILTER", + "ALL": "ALL", + } + + @schemas.classproperty + def WORKSPACE_DATA_FILTERS(cls): + return cls("workspaceDataFilters") + + @schemas.classproperty + def WORKSPACE_DATA_FILTER(cls): + return cls("workspaceDataFilter") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiWorkspaceDataFilterSettingInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiWorkspaceDataFilterSettingInDocument + + +request_body_json_api_workspace_data_filter_setting_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiWorkspaceDataFilterSettingOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiWorkspaceDataFilterSettingOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Put a Settings for Workspace Data Filter + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_workspace_data_filter_setting_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityWorkspaceDataFilterSettings(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_workspace_data_filter_settings_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_workspace_data_filter_settings_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/put.pyi new file mode 100644 index 000000000..9d25f2a05 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_object_id/put.pyi @@ -0,0 +1,552 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +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 + +# Query params +FilterSchema = schemas.StrSchema + + +class IncludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def WORKSPACE_DATA_FILTERS(cls): + return cls("workspaceDataFilters") + + @schemas.classproperty + def WORKSPACE_DATA_FILTER(cls): + return cls("workspaceDataFilter") + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'IncludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'filter': typing.Union[FilterSchema, str, ], + 'include': typing.Union[IncludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_filter = api_client.QueryParameter( + name="filter", + style=api_client.ParameterStyle.FORM, + schema=FilterSchema, + explode=True, +) +request_query_include = api_client.QueryParameter( + name="include", + style=api_client.ParameterStyle.FORM, + schema=IncludeSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +ObjectIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + 'objectId': typing.Union[ObjectIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +request_path_object_id = api_client.PathParameter( + name="objectId", + style=api_client.ParameterStyle.SIMPLE, + schema=ObjectIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = JsonApiWorkspaceDataFilterSettingInDocument +SchemaForRequestBodyApplicationVndGooddataApijson = JsonApiWorkspaceDataFilterSettingInDocument + + +request_body_json_api_workspace_data_filter_setting_in_document = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationVndGooddataApijson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiWorkspaceDataFilterSettingOutDocument +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiWorkspaceDataFilterSettingOutDocument + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _update_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _update_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _update_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _update_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _update_entity_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Put a Settings for Workspace Data Filter + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + request_path_object_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_filter, + request_query_include, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_json_api_workspace_data_filter_setting_in_document.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class UpdateEntityWorkspaceDataFilterSettings(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def update_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def update_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def update_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def update_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def update_entity_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_workspace_data_filter_settings_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: typing_extensions.Literal["application/vnd.gooddata.api+json"], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,SchemaForRequestBodyApplicationVndGooddataApijson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._update_entity_workspace_data_filter_settings_oapg( + body=body, + query_params=query_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_search/__init__.py new file mode 100644 index 000000000..866ae0377 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_WORKSPACE_DATA_FILTER_SETTINGS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_search/post.py new file mode 100644 index 000000000..13f608cdf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiWorkspaceDataFilterSettingOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiWorkspaceDataFilterSettingOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for WorkspaceDataFilterSetting + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesWorkspaceDataFilterSettings(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_workspace_data_filter_settings_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_workspace_data_filter_settings_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_search/post.pyi new file mode 100644 index 000000000..6cca5c587 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filter_settings_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiWorkspaceDataFilterSettingOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiWorkspaceDataFilterSettingOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_workspace_data_filter_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for WorkspaceDataFilterSetting + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesWorkspaceDataFilterSettings(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_workspace_data_filter_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_workspace_data_filter_settings_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_workspace_data_filter_settings_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_search/__init__.py new file mode 100644 index 000000000..1bd62ac1d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_workspace_data_filters_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_WORKSPACE_DATA_FILTERS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_search/post.py new file mode 100644 index 000000000..a30c127fe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_search/post.py @@ -0,0 +1,529 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiWorkspaceDataFilterOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiWorkspaceDataFilterOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_workspace_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_workspace_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_workspace_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_workspace_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_workspace_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for WorkspaceDataFilter + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesWorkspaceDataFilters(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_workspace_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_workspace_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_workspace_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_workspace_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_workspace_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_workspace_data_filters_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_workspace_data_filters_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_search/post.pyi new file mode 100644 index 000000000..98923a6a2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_data_filters_search/post.pyi @@ -0,0 +1,516 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiWorkspaceDataFilterOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiWorkspaceDataFilterOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_workspace_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_workspace_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_workspace_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_workspace_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_workspace_data_filters_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Search request for WorkspaceDataFilter + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesWorkspaceDataFilters(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_workspace_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_workspace_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_workspace_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_workspace_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_workspace_data_filters( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_workspace_data_filters_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_workspace_data_filters_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_search/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_search/__init__.py new file mode 100644 index 000000000..ba6b7f168 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_search/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_entities_workspaces_workspace_id_workspace_settings_search import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_ENTITIES_WORKSPACES_WORKSPACE_ID_WORKSPACE_SETTINGS_SEARCH \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_search/post.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_search/post.py new file mode 100644 index 000000000..4d22ef0cc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_search/post.py @@ -0,0 +1,528 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +from . import path + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + + class MetaOapg: + enum_value_to_name = { + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE", + } + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiWorkspaceSettingOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiWorkspaceSettingOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_workspace_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_workspace_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_workspace_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_workspace_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_workspace_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesWorkspaceSettings(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_workspace_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_workspace_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_workspace_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_workspace_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_workspace_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_workspace_settings_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_workspace_settings_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_search/post.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_search/post.pyi new file mode 100644 index 000000000..5ddadb071 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_entities_workspaces_workspace_id_workspace_settings_search/post.pyi @@ -0,0 +1,515 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody + +# Query params + + +class OriginSchema( + schemas.EnumBase, + schemas.StrSchema +): + + @schemas.classproperty + def ALL(cls): + return cls("ALL") + + @schemas.classproperty + def PARENTS(cls): + return cls("PARENTS") + + @schemas.classproperty + def NATIVE(cls): + return cls("NATIVE") +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'origin': typing.Union[OriginSchema, str, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_origin = api_client.QueryParameter( + name="origin", + style=api_client.ParameterStyle.FORM, + schema=OriginSchema, + explode=True, +) +# Header params +XGDCVALIDATERELATIONSSchema = schemas.BoolSchema +RequestRequiredHeaderParams = typing_extensions.TypedDict( + 'RequestRequiredHeaderParams', + { + } +) +RequestOptionalHeaderParams = typing_extensions.TypedDict( + 'RequestOptionalHeaderParams', + { + 'X-GDC-VALIDATE-RELATIONS': typing.Union[XGDCVALIDATERELATIONSSchema, bool, ], + }, + total=False +) + + +class RequestHeaderParams(RequestRequiredHeaderParams, RequestOptionalHeaderParams): + pass + + +request_header_x_gdc_validate_relations = api_client.HeaderParameter( + name="X-GDC-VALIDATE-RELATIONS", + style=api_client.ParameterStyle.SIMPLE, + schema=XGDCVALIDATERELATIONSSchema, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = EntitySearchBody + + +request_body_entity_search_body = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = JsonApiWorkspaceSettingOutList +SchemaFor200ResponseBodyApplicationVndGooddataApijson = JsonApiWorkspaceSettingOutList + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + SchemaFor200ResponseBodyApplicationVndGooddataApijson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + 'application/vnd.gooddata.api+json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationVndGooddataApijson), + }, +) +_all_accept_content_types = ( + 'application/json', + 'application/vnd.gooddata.api+json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _search_entities_workspace_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _search_entities_workspace_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def _search_entities_workspace_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _search_entities_workspace_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _search_entities_workspace_settings_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestHeaderParams, header_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_origin, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + for parameter in ( + request_header_x_gdc_validate_relations, + ): + parameter_data = header_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _headers.extend(serialized_data) + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_entity_search_body.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='post'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SearchEntitiesWorkspaceSettings(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def search_entities_workspace_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def search_entities_workspace_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def search_entities_workspace_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def search_entities_workspace_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def search_entities_workspace_settings( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_workspace_settings_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForpost(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def post( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + query_params: RequestQueryParams = frozendict.frozendict(), + header_params: RequestHeaderParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._search_entities_workspace_settings_oapg( + body=body, + query_params=query_params, + header_params=header_params, + path_params=path_params, + content_type=content_type, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_custom_geo_collections/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_custom_geo_collections/__init__.py new file mode 100644 index 000000000..2e1e47d62 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_custom_geo_collections/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_layout_custom_geo_collections import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_LAYOUT_CUSTOM_GEO_COLLECTIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_custom_geo_collections/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_custom_geo_collections/get.py new file mode 100644 index 000000000..119fe3a12 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_custom_geo_collections/get.py @@ -0,0 +1,239 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_custom_geo_collections import DeclarativeCustomGeoCollections + +from . import path + +SchemaFor200ResponseBodyApplicationJson = DeclarativeCustomGeoCollections + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_custom_geo_collections_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_custom_geo_collections_layout_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_custom_geo_collections_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_custom_geo_collections_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all custom geo collections layout + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetCustomGeoCollectionsLayout(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_custom_geo_collections_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_custom_geo_collections_layout( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_custom_geo_collections_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_custom_geo_collections_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_custom_geo_collections_layout_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_custom_geo_collections_layout_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_custom_geo_collections/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_custom_geo_collections/get.pyi new file mode 100644 index 000000000..f6731f4a5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_custom_geo_collections/get.pyi @@ -0,0 +1,234 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_custom_geo_collections import DeclarativeCustomGeoCollections + +SchemaFor200ResponseBodyApplicationJson = DeclarativeCustomGeoCollections + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_custom_geo_collections_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_custom_geo_collections_layout_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_custom_geo_collections_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_custom_geo_collections_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all custom geo collections layout + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetCustomGeoCollectionsLayout(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_custom_geo_collections_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_custom_geo_collections_layout( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_custom_geo_collections_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_custom_geo_collections_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_custom_geo_collections_layout_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_custom_geo_collections_layout_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_custom_geo_collections/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_custom_geo_collections/put.py new file mode 100644 index 000000000..ed8e3d80e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_custom_geo_collections/put.py @@ -0,0 +1,303 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_custom_geo_collections import DeclarativeCustomGeoCollections + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = DeclarativeCustomGeoCollections + + +request_body_declarative_custom_geo_collections = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _set_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set all custom geo collections + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_declarative_custom_geo_collections.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetCustomGeoCollections(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_custom_geo_collections_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_custom_geo_collections_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_custom_geo_collections/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_custom_geo_collections/put.pyi new file mode 100644 index 000000000..6422d94a9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_custom_geo_collections/put.pyi @@ -0,0 +1,298 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_custom_geo_collections import DeclarativeCustomGeoCollections + +# body param +SchemaForRequestBodyApplicationJson = DeclarativeCustomGeoCollections + + +request_body_declarative_custom_geo_collections = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _set_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_custom_geo_collections_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set all custom geo collections + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_declarative_custom_geo_collections.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetCustomGeoCollections(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_custom_geo_collections( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_custom_geo_collections_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_custom_geo_collections_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_permissions/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_permissions/__init__.py new file mode 100644 index 000000000..0a7156d7a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_permissions/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_layout_data_sources_data_source_id_permissions import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_LAYOUT_DATA_SOURCES_DATA_SOURCE_ID_PERMISSIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_permissions/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_permissions/get.py new file mode 100644 index 000000000..bf18ba740 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_permissions/get.py @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_data_source_permissions import DeclarativeDataSourcePermissions + +from . import path + +# Path params +DataSourceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'dataSourceId': typing.Union[DataSourceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_data_source_id = api_client.PathParameter( + name="dataSourceId", + style=api_client.ParameterStyle.SIMPLE, + schema=DataSourceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = DeclarativeDataSourcePermissions + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_data_source_permissions_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_data_source_permissions_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_data_source_permissions_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_data_source_permissions_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get permissions for the data source + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_data_source_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetDataSourcePermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_data_source_permissions( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_data_source_permissions( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_data_source_permissions( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_data_source_permissions( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_data_source_permissions_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_data_source_permissions_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_permissions/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_permissions/get.pyi new file mode 100644 index 000000000..190c7971f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_permissions/get.pyi @@ -0,0 +1,288 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_data_source_permissions import DeclarativeDataSourcePermissions + +# Path params +DataSourceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'dataSourceId': typing.Union[DataSourceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_data_source_id = api_client.PathParameter( + name="dataSourceId", + style=api_client.ParameterStyle.SIMPLE, + schema=DataSourceIdSchema, + required=True, +) +SchemaFor200ResponseBodyApplicationJson = DeclarativeDataSourcePermissions + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_data_source_permissions_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_data_source_permissions_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_data_source_permissions_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_data_source_permissions_oapg( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get permissions for the data source + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_data_source_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetDataSourcePermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_data_source_permissions( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_data_source_permissions( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_data_source_permissions( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_data_source_permissions( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_data_source_permissions_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_data_source_permissions_oapg( + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_permissions/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_permissions/put.py new file mode 100644 index 000000000..ceec61cd4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_permissions/put.py @@ -0,0 +1,360 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_data_source_permissions import DeclarativeDataSourcePermissions + +from . import path + +# Path params +DataSourceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'dataSourceId': typing.Union[DataSourceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_data_source_id = api_client.PathParameter( + name="dataSourceId", + style=api_client.ParameterStyle.SIMPLE, + schema=DataSourceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = DeclarativeDataSourcePermissions + + +request_body_declarative_data_source_permissions = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _set_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set data source permissions. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_data_source_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_declarative_data_source_permissions.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetDataSourcePermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_data_source_permissions_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_data_source_permissions_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_permissions/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_permissions/put.pyi new file mode 100644 index 000000000..6405d5161 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_data_sources_data_source_id_permissions/put.pyi @@ -0,0 +1,355 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_data_source_permissions import DeclarativeDataSourcePermissions + +# Path params +DataSourceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'dataSourceId': typing.Union[DataSourceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_data_source_id = api_client.PathParameter( + name="dataSourceId", + style=api_client.ParameterStyle.SIMPLE, + schema=DataSourceIdSchema, + required=True, +) +# body param +SchemaForRequestBodyApplicationJson = DeclarativeDataSourcePermissions + + +request_body_declarative_data_source_permissions = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _set_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_data_source_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set data source permissions. + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_data_source_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_declarative_data_source_permissions.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetDataSourcePermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_data_source_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_data_source_permissions_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_data_source_permissions_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_export_templates/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_export_templates/__init__.py new file mode 100644 index 000000000..9931ec9fb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_export_templates/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_layout_export_templates import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_LAYOUT_EXPORT_TEMPLATES \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_export_templates/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_export_templates/get.py new file mode 100644 index 000000000..9c7303fa0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_export_templates/get.py @@ -0,0 +1,239 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates + +from . import path + +SchemaFor200ResponseBodyApplicationJson = DeclarativeExportTemplates + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_export_templates_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_export_templates_layout_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_export_templates_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_export_templates_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all export templates layout + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetExportTemplatesLayout(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_export_templates_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_export_templates_layout( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_export_templates_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_export_templates_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_export_templates_layout_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_export_templates_layout_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_export_templates/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_export_templates/get.pyi new file mode 100644 index 000000000..f2d13670f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_export_templates/get.pyi @@ -0,0 +1,234 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates + +SchemaFor200ResponseBodyApplicationJson = DeclarativeExportTemplates + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_export_templates_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_export_templates_layout_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_export_templates_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_export_templates_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all export templates layout + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetExportTemplatesLayout(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_export_templates_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_export_templates_layout( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_export_templates_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_export_templates_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_export_templates_layout_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_export_templates_layout_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_export_templates/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_export_templates/put.py new file mode 100644 index 000000000..da50e613e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_export_templates/put.py @@ -0,0 +1,303 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = DeclarativeExportTemplates + + +request_body_declarative_export_templates = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _set_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set all export templates + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_declarative_export_templates.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetExportTemplates(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_export_templates_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_export_templates_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_export_templates/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_export_templates/put.pyi new file mode 100644 index 000000000..3259b49dd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_export_templates/put.pyi @@ -0,0 +1,298 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates + +# body param +SchemaForRequestBodyApplicationJson = DeclarativeExportTemplates + + +request_body_declarative_export_templates = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _set_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_export_templates_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set all export templates + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_declarative_export_templates.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetExportTemplates(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_export_templates( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_export_templates_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_export_templates_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_identity_providers/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_identity_providers/__init__.py new file mode 100644 index 000000000..8f8d15653 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_identity_providers/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_layout_identity_providers import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_LAYOUT_IDENTITY_PROVIDERS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_identity_providers/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_identity_providers/get.py new file mode 100644 index 000000000..147e8c815 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_identity_providers/get.py @@ -0,0 +1,264 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider + +from . import path + + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeIdentityProvider']: + return DeclarativeIdentityProvider + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeIdentityProvider'], typing.List['DeclarativeIdentityProvider']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeIdentityProvider': + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_identity_providers_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_identity_providers_layout_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_identity_providers_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_identity_providers_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all identity providers layout + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetIdentityProvidersLayout(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_identity_providers_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_identity_providers_layout( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_identity_providers_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_identity_providers_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_identity_providers_layout_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_identity_providers_layout_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_identity_providers/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_identity_providers/get.pyi new file mode 100644 index 000000000..bafdf5392 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_identity_providers/get.pyi @@ -0,0 +1,259 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider + + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeIdentityProvider']: + return DeclarativeIdentityProvider + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeIdentityProvider'], typing.List['DeclarativeIdentityProvider']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeIdentityProvider': + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_identity_providers_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_identity_providers_layout_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_identity_providers_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_identity_providers_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all identity providers layout + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetIdentityProvidersLayout(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_identity_providers_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_identity_providers_layout( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_identity_providers_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_identity_providers_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_identity_providers_layout_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_identity_providers_layout_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_identity_providers/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_identity_providers/put.py new file mode 100644 index 000000000..31ecf51d6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_identity_providers/put.py @@ -0,0 +1,328 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider + +from . import path + +# body param + + +class SchemaForRequestBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeIdentityProvider']: + return DeclarativeIdentityProvider + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeIdentityProvider'], typing.List['DeclarativeIdentityProvider']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaForRequestBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeIdentityProvider': + return super().__getitem__(i) + + +request_body_declarative_identity_provider = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _set_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set all identity providers + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_declarative_identity_provider.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetIdentityProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_identity_providers_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_identity_providers_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_identity_providers/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_identity_providers/put.pyi new file mode 100644 index 000000000..8d00e7e20 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_identity_providers/put.pyi @@ -0,0 +1,323 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider + +# body param + + +class SchemaForRequestBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeIdentityProvider']: + return DeclarativeIdentityProvider + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeIdentityProvider'], typing.List['DeclarativeIdentityProvider']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaForRequestBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeIdentityProvider': + return super().__getitem__(i) + + +request_body_declarative_identity_provider = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _set_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_identity_providers_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set all identity providers + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_declarative_identity_provider.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetIdentityProviders(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_identity_providers( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_identity_providers_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_identity_providers_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_notification_channels/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_notification_channels/__init__.py new file mode 100644 index 000000000..24dcd0962 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_notification_channels/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_layout_notification_channels import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_LAYOUT_NOTIFICATION_CHANNELS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_notification_channels/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_notification_channels/get.py new file mode 100644 index 000000000..7636074bb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_notification_channels/get.py @@ -0,0 +1,239 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels + +from . import path + +SchemaFor200ResponseBodyApplicationJson = DeclarativeNotificationChannels + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_notification_channels_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_notification_channels_layout_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_notification_channels_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_notification_channels_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all notification channels layout + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetNotificationChannelsLayout(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_notification_channels_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_notification_channels_layout( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_notification_channels_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_notification_channels_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_notification_channels_layout_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_notification_channels_layout_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_notification_channels/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_notification_channels/get.pyi new file mode 100644 index 000000000..080b2c35d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_notification_channels/get.pyi @@ -0,0 +1,234 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels + +SchemaFor200ResponseBodyApplicationJson = DeclarativeNotificationChannels + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_notification_channels_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_notification_channels_layout_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_notification_channels_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_notification_channels_layout_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get all notification channels layout + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetNotificationChannelsLayout(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_notification_channels_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_notification_channels_layout( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_notification_channels_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_notification_channels_layout( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_notification_channels_layout_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_notification_channels_layout_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_notification_channels/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_notification_channels/put.py new file mode 100644 index 000000000..c765eb8f4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_notification_channels/put.py @@ -0,0 +1,303 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels + +from . import path + +# body param +SchemaForRequestBodyApplicationJson = DeclarativeNotificationChannels + + +request_body_declarative_notification_channels = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _set_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set all notification channels + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_declarative_notification_channels.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetNotificationChannels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_notification_channels_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_notification_channels_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_notification_channels/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_notification_channels/put.pyi new file mode 100644 index 000000000..1abf73c39 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_notification_channels/put.pyi @@ -0,0 +1,298 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels + +# body param +SchemaForRequestBodyApplicationJson = DeclarativeNotificationChannels + + +request_body_declarative_notification_channels = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _set_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_notification_channels_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set all notification channels + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_declarative_notification_channels.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetNotificationChannels(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_notification_channels( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_notification_channels_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_notification_channels_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization_permissions/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization_permissions/__init__.py new file mode 100644 index 000000000..a3fbe7629 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization_permissions/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_layout_organization_permissions import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_LAYOUT_ORGANIZATION_PERMISSIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization_permissions/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization_permissions/get.py new file mode 100644 index 000000000..cd76520e0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization_permissions/get.py @@ -0,0 +1,264 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission + +from . import path + + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeOrganizationPermission']: + return DeclarativeOrganizationPermission + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeOrganizationPermission'], typing.List['DeclarativeOrganizationPermission']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeOrganizationPermission': + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_organization_permissions_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_organization_permissions_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_organization_permissions_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_organization_permissions_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get organization permissions + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetOrganizationPermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_organization_permissions( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_organization_permissions( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_organization_permissions( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_organization_permissions( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_organization_permissions_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_organization_permissions_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization_permissions/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization_permissions/get.pyi new file mode 100644 index 000000000..314cf97d4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization_permissions/get.pyi @@ -0,0 +1,259 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission + + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeOrganizationPermission']: + return DeclarativeOrganizationPermission + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeOrganizationPermission'], typing.List['DeclarativeOrganizationPermission']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeOrganizationPermission': + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_organization_permissions_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_organization_permissions_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_organization_permissions_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_organization_permissions_oapg( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get organization permissions + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetOrganizationPermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_organization_permissions( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_organization_permissions( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_organization_permissions( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_organization_permissions( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_organization_permissions_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_organization_permissions_oapg( + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization_permissions/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization_permissions/put.py new file mode 100644 index 000000000..efd8b341a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization_permissions/put.py @@ -0,0 +1,328 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission + +from . import path + +# body param + + +class SchemaForRequestBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeOrganizationPermission']: + return DeclarativeOrganizationPermission + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeOrganizationPermission'], typing.List['DeclarativeOrganizationPermission']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaForRequestBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeOrganizationPermission': + return super().__getitem__(i) + + +request_body_declarative_organization_permission = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _set_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set organization permissions + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_declarative_organization_permission.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetOrganizationPermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_organization_permissions_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_organization_permissions_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization_permissions/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization_permissions/put.pyi new file mode 100644 index 000000000..578eb9fa8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_organization_permissions/put.pyi @@ -0,0 +1,323 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission + +# body param + + +class SchemaForRequestBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeOrganizationPermission']: + return DeclarativeOrganizationPermission + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeOrganizationPermission'], typing.List['DeclarativeOrganizationPermission']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaForRequestBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeOrganizationPermission': + return super().__getitem__(i) + + +request_body_declarative_organization_permission = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _set_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_organization_permissions_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set organization permissions + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + used_path = path.value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_declarative_organization_permission.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetOrganizationPermissions(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_organization_permissions( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_organization_permissions_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_organization_permissions_oapg( + body=body, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_automations/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_automations/__init__.py new file mode 100644 index 000000000..3f2a40a9c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_automations/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_layout_workspaces_workspace_id_automations import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_LAYOUT_WORKSPACES_WORKSPACE_ID_AUTOMATIONS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_automations/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_automations/get.py new file mode 100644 index 000000000..49e1def3e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_automations/get.py @@ -0,0 +1,409 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_automation import DeclarativeAutomation + +from . import path + +# Query params + + +class ExcludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "ACTIVITY_INFO": "ACTIVITY_INFO", + } + + @schemas.classproperty + def ACTIVITY_INFO(cls): + return cls("ACTIVITY_INFO") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ExcludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'exclude': typing.Union[ExcludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_exclude = api_client.QueryParameter( + name="exclude", + style=api_client.ParameterStyle.FORM, + schema=ExcludeSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeAutomation']: + return DeclarativeAutomation + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeAutomation'], typing.List['DeclarativeAutomation']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeAutomation': + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_automations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get automations + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_exclude, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_automations( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_automations_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_automations_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_automations/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_automations/get.pyi new file mode 100644 index 000000000..778cc614a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_automations/get.pyi @@ -0,0 +1,398 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_automation import DeclarativeAutomation + +# Query params + + +class ExcludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ACTIVITY_INFO(cls): + return cls("ACTIVITY_INFO") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ExcludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'exclude': typing.Union[ExcludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_exclude = api_client.QueryParameter( + name="exclude", + style=api_client.ParameterStyle.FORM, + schema=ExcludeSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeAutomation']: + return DeclarativeAutomation + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeAutomation'], typing.List['DeclarativeAutomation']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeAutomation': + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_automations_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_automations_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get automations + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_exclude, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_automations( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_automations( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_automations_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_automations_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_automations/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_automations/put.py new file mode 100644 index 000000000..168d92cb6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_automations/put.py @@ -0,0 +1,385 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_automation import DeclarativeAutomation + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param + + +class SchemaForRequestBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeAutomation']: + return DeclarativeAutomation + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeAutomation'], typing.List['DeclarativeAutomation']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaForRequestBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeAutomation': + return super().__getitem__(i) + + +request_body_declarative_automation = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _set_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set automations + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_declarative_automation.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_automations/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_automations/put.pyi new file mode 100644 index 000000000..7336cc01b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_automations/put.pyi @@ -0,0 +1,380 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_automation import DeclarativeAutomation + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param + + +class SchemaForRequestBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeAutomation']: + return DeclarativeAutomation + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeAutomation'], typing.List['DeclarativeAutomation']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaForRequestBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeAutomation': + return super().__getitem__(i) + + +request_body_declarative_automation = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _set_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_automations_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set automations + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_declarative_automation.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetAutomations(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_automations( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_automations_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_filter_views/__init__.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_filter_views/__init__.py new file mode 100644 index 000000000..9954d8a78 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_filter_views/__init__.py @@ -0,0 +1,7 @@ +# do not import all endpoints into this module because that uses a lot of memory and stack frames +# if you need the ability to import all endpoints from this module, import them with +# from gooddata_api_client.paths.api_v1_layout_workspaces_workspace_id_filter_views import Api + +from gooddata_api_client.paths import PathValues + +path = PathValues.API_V1_LAYOUT_WORKSPACES_WORKSPACE_ID_FILTER_VIEWS \ No newline at end of file diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_filter_views/get.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_filter_views/get.py new file mode 100644 index 000000000..49f1d403e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_filter_views/get.py @@ -0,0 +1,409 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView + +from . import path + +# Query params + + +class ExcludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + + class MetaOapg: + enum_value_to_name = { + "ACTIVITY_INFO": "ACTIVITY_INFO", + } + + @schemas.classproperty + def ACTIVITY_INFO(cls): + return cls("ACTIVITY_INFO") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ExcludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'exclude': typing.Union[ExcludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_exclude = api_client.QueryParameter( + name="exclude", + style=api_client.ParameterStyle.FORM, + schema=ExcludeSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeFilterView']: + return DeclarativeFilterView + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeFilterView'], typing.List['DeclarativeFilterView']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeFilterView': + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_status_code_to_response = { + '200': _response_for_200, +} +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_filter_views_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get filter views + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_exclude, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_filter_views( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_filter_views_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_filter_views_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_filter_views/get.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_filter_views/get.pyi new file mode 100644 index 000000000..f69cb52b1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_filter_views/get.pyi @@ -0,0 +1,398 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView + +# Query params + + +class ExcludeSchema( + schemas.ListSchema +): + + + class MetaOapg: + + + class items( + schemas.EnumBase, + schemas.StrSchema + ): + + @schemas.classproperty + def ACTIVITY_INFO(cls): + return cls("ACTIVITY_INFO") + + def __new__( + cls, + _arg: typing.Union[typing.Tuple[typing.Union[MetaOapg.items, str, ]], typing.List[typing.Union[MetaOapg.items, str, ]]], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'ExcludeSchema': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> MetaOapg.items: + return super().__getitem__(i) +RequestRequiredQueryParams = typing_extensions.TypedDict( + 'RequestRequiredQueryParams', + { + } +) +RequestOptionalQueryParams = typing_extensions.TypedDict( + 'RequestOptionalQueryParams', + { + 'exclude': typing.Union[ExcludeSchema, list, tuple, ], + }, + total=False +) + + +class RequestQueryParams(RequestRequiredQueryParams, RequestOptionalQueryParams): + pass + + +request_query_exclude = api_client.QueryParameter( + name="exclude", + style=api_client.ParameterStyle.FORM, + schema=ExcludeSchema, + explode=True, +) +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) + + +class SchemaFor200ResponseBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeFilterView']: + return DeclarativeFilterView + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeFilterView'], typing.List['DeclarativeFilterView']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaFor200ResponseBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeFilterView': + return super().__getitem__(i) + + +@dataclass +class ApiResponseFor200(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: typing.Union[ + SchemaFor200ResponseBodyApplicationJson, + ] + headers: schemas.Unset = schemas.unset + + +_response_for_200 = api_client.OpenApiResponse( + response_cls=ApiResponseFor200, + content={ + 'application/json': api_client.MediaType( + schema=SchemaFor200ResponseBodyApplicationJson), + }, +) +_all_accept_content_types = ( + 'application/json', +) + + +class BaseApi(api_client.Api): + @typing.overload + def _get_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def _get_filter_views_oapg( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _get_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _get_filter_views_oapg( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Get filter views + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestQueryParams, query_params) + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + prefix_separator_iterator = None + for parameter in ( + request_query_exclude, + ): + parameter_data = query_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + if prefix_separator_iterator is None: + prefix_separator_iterator = parameter.get_prefix_separator_iterator() + serialized_data = parameter.serialize(parameter_data, prefix_separator_iterator) + for serialized_value in serialized_data.values(): + used_path += serialized_value + + _headers = HTTPHeaderDict() + # TODO add cookie handling + if accept_content_types: + for accept_content_type in accept_content_types: + _headers.add('Accept', accept_content_type) + + response = self.api_client.call_api( + resource_path=used_path, + method='get'.upper(), + headers=_headers, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class GetFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def get_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get_filter_views( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get_filter_views( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_filter_views_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForget(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor200, + ]: ... + + @typing.overload + def get( + self, + skip_deserialization: typing_extensions.Literal[True], + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor200, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def get( + self, + query_params: RequestQueryParams = frozendict.frozendict(), + path_params: RequestPathParams = frozendict.frozendict(), + accept_content_types: typing.Tuple[str] = _all_accept_content_types, + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._get_filter_views_oapg( + query_params=query_params, + path_params=path_params, + accept_content_types=accept_content_types, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_filter_views/put.py b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_filter_views/put.py new file mode 100644 index 000000000..a5bc6d4d1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_filter_views/put.py @@ -0,0 +1,385 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView + +from . import path + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param + + +class SchemaForRequestBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeFilterView']: + return DeclarativeFilterView + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeFilterView'], typing.List['DeclarativeFilterView']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaForRequestBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeFilterView': + return super().__getitem__(i) + + +request_body_declarative_filter_view = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) +_status_code_to_response = { + '204': _response_for_204, +} + + +class BaseApi(api_client.Api): + @typing.overload + def _set_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set filter views + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_declarative_filter_view.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_filter_views_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_filter_views_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_filter_views/put.pyi b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_filter_views/put.pyi new file mode 100644 index 000000000..88ad1f460 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/paths/api_v1_layout_workspaces_workspace_id_filter_views/put.pyi @@ -0,0 +1,380 @@ +# coding: utf-8 + +""" + + + Generated by: https://openapi-generator.tech +""" + +from dataclasses import dataclass +import typing_extensions +import urllib3 +from urllib3._collections import HTTPHeaderDict + +from gooddata_api_client import api_client, exceptions +from datetime import date, datetime # noqa: F401 +import decimal # noqa: F401 +import functools # noqa: F401 +import io # noqa: F401 +import re # noqa: F401 +import typing # noqa: F401 +import typing_extensions # noqa: F401 +import uuid # noqa: F401 + +import frozendict # noqa: F401 + +from gooddata_api_client import schemas # noqa: F401 + +from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView + +# Path params +WorkspaceIdSchema = schemas.StrSchema +RequestRequiredPathParams = typing_extensions.TypedDict( + 'RequestRequiredPathParams', + { + 'workspaceId': typing.Union[WorkspaceIdSchema, str, ], + } +) +RequestOptionalPathParams = typing_extensions.TypedDict( + 'RequestOptionalPathParams', + { + }, + total=False +) + + +class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams): + pass + + +request_path_workspace_id = api_client.PathParameter( + name="workspaceId", + style=api_client.ParameterStyle.SIMPLE, + schema=WorkspaceIdSchema, + required=True, +) +# body param + + +class SchemaForRequestBodyApplicationJson( + schemas.ListSchema +): + + + class MetaOapg: + + @staticmethod + def items() -> typing.Type['DeclarativeFilterView']: + return DeclarativeFilterView + + def __new__( + cls, + _arg: typing.Union[typing.Tuple['DeclarativeFilterView'], typing.List['DeclarativeFilterView']], + _configuration: typing.Optional[schemas.Configuration] = None, + ) -> 'SchemaForRequestBodyApplicationJson': + return super().__new__( + cls, + _arg, + _configuration=_configuration, + ) + + def __getitem__(self, i: int) -> 'DeclarativeFilterView': + return super().__getitem__(i) + + +request_body_declarative_filter_view = api_client.RequestBody( + content={ + 'application/json': api_client.MediaType( + schema=SchemaForRequestBodyApplicationJson), + }, + required=True, +) + + +@dataclass +class ApiResponseFor204(api_client.ApiResponse): + response: urllib3.HTTPResponse + body: schemas.Unset = schemas.unset + headers: schemas.Unset = schemas.unset + + +_response_for_204 = api_client.OpenApiResponse( + response_cls=ApiResponseFor204, +) + + +class BaseApi(api_client.Api): + @typing.overload + def _set_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def _set_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def _set_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def _set_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def _set_filter_views_oapg( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + """ + Set filter views + :param skip_deserialization: If true then api_response.response will be set but + api_response.body and api_response.headers will not be deserialized into schema + class instances + """ + self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params) + used_path = path.value + + _path_params = {} + for parameter in ( + request_path_workspace_id, + ): + parameter_data = path_params.get(parameter.name, schemas.unset) + if parameter_data is schemas.unset: + continue + serialized_data = parameter.serialize(parameter_data) + _path_params.update(serialized_data) + + for k, v in _path_params.items(): + used_path = used_path.replace('{%s}' % k, v) + + _headers = HTTPHeaderDict() + # TODO add cookie handling + + if body is schemas.unset: + raise exceptions.ApiValueError( + 'The required body parameter has an invalid value of: unset. Set a valid value instead') + _fields = None + _body = None + serialized_data = request_body_declarative_filter_view.serialize(body, content_type) + _headers.add('Content-Type', content_type) + if 'fields' in serialized_data: + _fields = serialized_data['fields'] + elif 'body' in serialized_data: + _body = serialized_data['body'] + response = self.api_client.call_api( + resource_path=used_path, + method='put'.upper(), + headers=_headers, + fields=_fields, + body=_body, + stream=stream, + timeout=timeout, + ) + + if skip_deserialization: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + else: + response_for_status = _status_code_to_response.get(str(response.status)) + if response_for_status: + api_response = response_for_status.deserialize(response, self.api_client.configuration) + else: + api_response = api_client.ApiResponseWithoutDeserialization(response=response) + + if not 200 <= response.status <= 299: + raise exceptions.ApiException( + status=response.status, + reason=response.reason, + api_response=api_response + ) + + return api_response + + +class SetFilterViews(BaseApi): + # this class is used by api classes that refer to endpoints with operationId fn names + + @typing.overload + def set_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def set_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def set_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def set_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def set_filter_views( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_filter_views_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + +class ApiForput(BaseApi): + # this class is used by api classes that refer to endpoints by path and http method names + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: typing_extensions.Literal["application/json"] = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: typing_extensions.Literal[False] = ..., + ) -> typing.Union[ + ApiResponseFor204, + ]: ... + + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + skip_deserialization: typing_extensions.Literal[True], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + ) -> api_client.ApiResponseWithoutDeserialization: ... + + @typing.overload + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = ..., + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = ..., + ) -> typing.Union[ + ApiResponseFor204, + api_client.ApiResponseWithoutDeserialization, + ]: ... + + def put( + self, + body: typing.Union[SchemaForRequestBodyApplicationJson,list, tuple, ], + content_type: str = 'application/json', + path_params: RequestPathParams = frozendict.frozendict(), + stream: bool = False, + timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, + skip_deserialization: bool = False, + ): + return self._set_filter_views_oapg( + body=body, + path_params=path_params, + content_type=content_type, + stream=stream, + timeout=timeout, + skip_deserialization=skip_deserialization + ) + + diff --git a/schemas/gooddata-afm-client.json b/schemas/gooddata-afm-client.json index 31dab5da5..e1b8af1be 100644 --- a/schemas/gooddata-afm-client.json +++ b/schemas/gooddata-afm-client.json @@ -25,6 +25,13 @@ }, "type": "array" }, + "measureDefinitionOverrides": { + "description": "(EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric's MAQL definition without modifying the stored definition.", + "items": { + "$ref": "#/components/schemas/MetricDefinitionOverride" + }, + "type": "array" + }, "measures": { "description": "Metrics to be computed.", "items": { @@ -76,9 +83,9 @@ } }, "required": [ + "dataset", "from", - "to", - "dataset" + "to" ], "type": "object" } @@ -598,6 +605,24 @@ ], "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": { @@ -930,6 +955,146 @@ ], "type": "object" }, + "AwsBedrockAccessKeyAuth": { + "allOf": [ + { + "properties": { + "accessKeyId": { + "description": "AWS Access Key ID.", + "maxLength": 255, + "nullable": true, + "type": "string", + "writeOnly": true + }, + "secretAccessKey": { + "description": "AWS Secret Access Key.", + "maxLength": 10000, + "nullable": true, + "type": "string", + "writeOnly": true + }, + "sessionToken": { + "description": "AWS Session Token (for temporary credentials).", + "maxLength": 10000, + "nullable": true, + "type": "string", + "writeOnly": true + }, + "type": { + "description": "Authentication type.", + "enum": [ + "ACCESS_KEY" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "required": [ + "type" + ], + "type": "object" + }, + "AwsBedrockProviderConfig": { + "description": "Configuration for AWS Bedrock provider.", + "properties": { + "auth": { + "$ref": "#/components/schemas/BedrockProviderAuth" + }, + "region": { + "description": "AWS region for Bedrock.", + "example": "us-east-1", + "maxLength": 255, + "type": "string" + }, + "type": { + "description": "Provider type.", + "enum": [ + "AWS_BEDROCK" + ], + "type": "string" + } + }, + "required": [ + "auth", + "region", + "type" + ], + "type": "object" + }, + "AzureFoundryApiKeyAuth": { + "allOf": [ + { + "properties": { + "apiKey": { + "description": "Azure 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" + }, + "AzureFoundryProviderAuth": { + "description": "Authentication configuration.", + "oneOf": [ + { + "$ref": "#/components/schemas/AzureFoundryApiKeyAuth" + } + ], + "type": "object" + }, + "AzureFoundryProviderConfig": { + "description": "Configuration for Azure Foundry provider.", + "properties": { + "auth": { + "$ref": "#/components/schemas/AzureFoundryProviderAuth" + }, + "endpoint": { + "description": "Azure AI inference endpoint URL.", + "example": "https://my-resource.services.ai.azure.com/models", + "maxLength": 255, + "type": "string" + }, + "type": { + "description": "Provider type.", + "enum": [ + "AZURE_FOUNDRY" + ], + "type": "string" + } + }, + "required": [ + "auth", + "endpoint", + "type" + ], + "type": "object" + }, + "BedrockProviderAuth": { + "description": "Authentication configuration.", + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockAccessKeyAuth" + } + ], + "type": "object" + }, "BoundedFilter": { "description": "Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range.", "properties": { @@ -1427,6 +1592,26 @@ ], "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": { @@ -1580,9 +1765,9 @@ } }, "required": [ + "measure", "operator", - "value", - "measure" + "value" ], "type": "object" } @@ -1638,9 +1823,67 @@ ], "type": "object" }, + "CreateKnowledgeDocumentRequestDto": { + "properties": { + "content": { + "type": "string" + }, + "filename": { + "type": "string" + }, + "pageBoundaries": { + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "scopes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "type": "string" + } + }, + "required": [ + "content", + "filename" + ], + "type": "object" + }, + "CreateKnowledgeDocumentResponseDto": { + "properties": { + "filename": { + "type": "string" + }, + "message": { + "type": "string" + }, + "numChunks": { + "format": "int32", + "type": "integer" + }, + "success": { + "type": "boolean" + } + }, + "required": [ + "filename", + "message", + "numChunks", + "success" + ], + "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": { @@ -1707,7 +1950,8 @@ "BAR", "LINE", "PIE", - "COLUMN" + "COLUMN", + "SCATTER" ], "example": "TABLE", "type": "string" @@ -1863,6 +2107,9 @@ }, { "$ref": "#/components/schemas/RelativeDateFilter" + }, + { + "$ref": "#/components/schemas/AllTimeDateFilter" } ], "type": "object" @@ -1921,6 +2168,21 @@ ], "type": "object" }, + "DeleteKnowledgeDocumentResponseDto": { + "properties": { + "message": { + "type": "string" + }, + "success": { + "type": "boolean" + } + }, + "required": [ + "message", + "success" + ], + "type": "object" + }, "DependsOn": { "allOf": [ { @@ -2523,10 +2785,10 @@ "$ref": "#/components/schemas/AbsoluteDateFilter" }, { - "$ref": "#/components/schemas/AllTimeDateFilter" + "$ref": "#/components/schemas/RelativeDateFilter" }, { - "$ref": "#/components/schemas/RelativeDateFilter" + "$ref": "#/components/schemas/AllTimeDateFilter" }, { "$ref": "#/components/schemas/NegativeAttributeFilter" @@ -2552,6 +2814,31 @@ ], "type": "object" }, + "ForecastConfig": { + "description": "Forecast configuration.", + "properties": { + "confidenceLevel": { + "description": "Confidence interval boundary value.", + "format": "float", + "type": "number" + }, + "forecastPeriod": { + "description": "Number of future periods that should be forecasted", + "format": "int32", + "type": "integer" + }, + "seasonal": { + "description": "Whether the input data is seasonal", + "type": "boolean" + } + }, + "required": [ + "confidenceLevel", + "forecastPeriod", + "seasonal" + ], + "type": "object" + }, "ForecastRequest": { "properties": { "confidenceLevel": { @@ -2647,6 +2934,80 @@ ], "type": "object" }, + "GenerateDescriptionRequest": { + "properties": { + "objectId": { + "description": "Identifier of the object to describe", + "type": "string" + }, + "objectType": { + "description": "Type of the object to describe. One of: visualization, dashboard, metric, fact, attribute", + "enum": [ + "Visualization", + "Dashboard", + "Metric", + "Fact", + "Attribute" + ], + "type": "string" + } + }, + "required": [ + "objectId", + "objectType" + ], + "type": "object" + }, + "GenerateDescriptionResponse": { + "properties": { + "description": { + "description": "Generated description of the requested object", + "type": "string" + }, + "note": { + "description": "Additional note with details in case generation was not performed", + "type": "string" + } + }, + "type": "object" + }, + "GenerateTitleRequest": { + "properties": { + "objectId": { + "description": "Identifier of the object to title", + "type": "string" + }, + "objectType": { + "description": "Type of the object to title. Matches chat-search object types.", + "enum": [ + "Visualization", + "Dashboard", + "Metric", + "Fact", + "Attribute" + ], + "type": "string" + } + }, + "required": [ + "objectId", + "objectType" + ], + "type": "object" + }, + "GenerateTitleResponse": { + "properties": { + "note": { + "description": "Additional note with details in case generation was not performed", + "type": "string" + }, + "title": { + "description": "Generated title of the requested object", + "type": "string" + } + }, + "type": "object" + }, "GeoAreaConfig": { "description": "Configuration specific to geo area labels.", "properties": { @@ -2697,6 +3058,7 @@ "SYNCING", "COMPLETED", "FAILED", + "CANCELLED", "NOT_FOUND", "DISABLED" ], @@ -2777,6 +3139,11 @@ ], "type": "object" }, + "JsonNode": { + "description": "The payload to pass to the command", + "nullable": true, + "type": "object" + }, "KeyDriversDimension": { "properties": { "attribute": { @@ -2895,11 +3262,173 @@ ], "type": "object" }, - "MatchAttributeFilter": { - "description": "Filter via label with given match type and literal value.", + "KnowledgeDocumentMetadataDto": { "properties": { - "matchAttributeFilter": { - "properties": { + "createdAt": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "filename": { + "type": "string" + }, + "isDisabled": { + "type": "boolean" + }, + "numChunks": { + "format": "int32", + "type": "integer" + }, + "scopes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "updatedAt": { + "type": "string" + }, + "updatedBy": { + "type": "string" + }, + "workspaceId": { + "type": "string" + } + }, + "required": [ + "createdAt", + "createdBy", + "filename", + "numChunks", + "scopes", + "updatedAt", + "updatedBy" + ], + "type": "object" + }, + "KnowledgeSearchResultDto": { + "properties": { + "chunkIndex": { + "format": "int32", + "type": "integer" + }, + "content": { + "type": "string" + }, + "filename": { + "type": "string" + }, + "pageNumbers": { + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "scopes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "score": { + "format": "float", + "type": "number" + }, + "title": { + "type": "string" + }, + "totalChunks": { + "format": "int32", + "type": "integer" + }, + "workspaceId": { + "type": "string" + } + }, + "required": [ + "chunkIndex", + "content", + "filename", + "pageNumbers", + "scopes", + "score", + "totalChunks" + ], + "type": "object" + }, + "ListKnowledgeDocumentsResponseDto": { + "properties": { + "documents": { + "items": { + "$ref": "#/components/schemas/KnowledgeDocumentMetadataDto" + }, + "type": "array" + }, + "nextPageToken": { + "type": "string" + }, + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "documents" + ], + "type": "object" + }, + "LlmModel": { + "description": "LLM Model configuration (id, family) within a provider.", + "properties": { + "family": { + "description": "Family of LLM models.", + "enum": [ + "OPENAI", + "ANTHROPIC", + "META", + "MISTRAL", + "AMAZON", + "GOOGLE", + "COHERE" + ], + "type": "string" + }, + "id": { + "description": "Unique identifier of the model (e.g., gpt-5.3, claude-4.6).", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "family", + "id" + ], + "type": "object" + }, + "LlmProviderConfig": { + "description": "Provider configuration to test.", + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockProviderConfig" + }, + { + "$ref": "#/components/schemas/AzureFoundryProviderConfig" + }, + { + "$ref": "#/components/schemas/OpenAIProviderConfig" + } + ] + }, + "MatchAttributeFilter": { + "description": "Filter via label with given match type and literal value.", + "properties": { + "matchAttributeFilter": { + "properties": { "applyOnResult": { "type": "boolean" }, @@ -2935,9 +3464,9 @@ } }, "required": [ + "label", "literal", - "matchType", - "label" + "matchType" ], "type": "object" } @@ -3154,6 +3683,22 @@ ], "type": "object" }, + "MetricDefinitionOverride": { + "description": "(EXPERIMENTAL) Override for a catalog metric definition.", + "properties": { + "definition": { + "$ref": "#/components/schemas/InlineMeasureDefinition" + }, + "item": { + "$ref": "#/components/schemas/AfmObjectIdentifierCore" + } + }, + "required": [ + "definition", + "item" + ], + "type": "object" + }, "MetricValueChange": { "description": "Individual change analysis data item", "properties": { @@ -3225,6 +3770,29 @@ ], "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": { @@ -3244,8 +3812,8 @@ } }, "required": [ - "notIn", - "label" + "label", + "notIn" ], "type": "object" } @@ -3255,6 +3823,75 @@ ], "type": "object" }, + "OpenAIProviderConfig": { + "description": "Configuration for OpenAI provider.", + "properties": { + "auth": { + "$ref": "#/components/schemas/OpenAiProviderAuth" + }, + "baseUrl": { + "default": "https://api.openai.com", + "description": "Custom base URL for OpenAI API.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "organization": { + "description": "OpenAI organization ID.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "type": { + "description": "Provider type.", + "enum": [ + "OPENAI" + ], + "type": "string" + } + }, + "required": [ + "auth", + "type" + ], + "type": "object" + }, + "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" + }, "Operation": { "description": "Represents a Long-Running Operation: a process that takes some time to complete.", "discriminator": { @@ -3271,10 +3908,11 @@ "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", + "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", "enum": [ "provision-database", - "deprovision-database" + "deprovision-database", + "run-service-command" ], "type": "string" }, @@ -3461,6 +4099,23 @@ ], "type": "object" }, + "PatchKnowledgeDocumentRequestDto": { + "properties": { + "isDisabled": { + "type": "boolean" + }, + "scopes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "type": "string" + } + }, + "type": "object" + }, "PendingOperation": { "allOf": [ { @@ -3729,6 +4384,7 @@ "SYNCING", "COMPLETED", "FAILED", + "CANCELLED", "NOT_FOUND", "DISABLED" ], @@ -3820,9 +4476,9 @@ }, "required": [ "from", + "measure", "operator", - "to", - "measure" + "to" ], "type": "object" } @@ -3993,10 +4649,10 @@ } }, "required": [ + "dataset", "from", "granularity", - "to", - "dataset" + "to" ], "type": "object" } @@ -4162,6 +4818,25 @@ ], "type": "object" }, + "RunServiceCommandRequest": { + "description": "Request to run an AI Lake Service Command", + "properties": { + "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" + }, + "payload": { + "$ref": "#/components/schemas/JsonNode" + } + }, + "type": "object" + }, "SavedVisualization": { "description": "Created and saved visualization IDs.", "properties": { @@ -4180,6 +4855,24 @@ ], "type": "object" }, + "SearchKnowledgeResponseDto": { + "properties": { + "results": { + "items": { + "$ref": "#/components/schemas/KnowledgeSearchResultDto" + }, + "type": "array" + }, + "statistics": { + "$ref": "#/components/schemas/SearchStatisticsDto" + } + }, + "required": [ + "results", + "statistics" + ], + "type": "object" + }, "SearchRelationshipObject": { "properties": { "sourceObjectId": { @@ -4417,18 +5110,53 @@ ], "type": "object" }, + "SearchStatisticsDto": { + "properties": { + "averageSimilarityScore": { + "format": "float", + "type": "number" + }, + "totalResults": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "averageSimilarityScore", + "totalResults" + ], + "type": "object" + }, "ServerSentEventChatResult": { "type": "object" }, - "SimpleMeasureDefinition": { - "description": "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.", + "ServiceInfo": { + "description": "Non-sensitive metadata for an AI Lake pipeline", "properties": { - "measure": { - "properties": { - "aggregation": { - "description": "Definition of aggregation type of the metric.", - "enum": [ - "SUM", + "name": { + "description": "Human-readable name of the service", + "type": "string" + }, + "serviceId": { + "description": "Internal identifier for the service configuration (UUID)", + "type": "string" + } + }, + "required": [ + "name", + "serviceId" + ], + "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", @@ -4634,6 +5362,59 @@ ], "type": "object" }, + "TestLlmProviderDefinitionRequest": { + "properties": { + "models": { + "description": "Models to test.", + "items": { + "$ref": "#/components/schemas/LlmModel" + }, + "type": "array" + }, + "providerConfig": { + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockProviderConfig" + }, + { + "$ref": "#/components/schemas/AzureFoundryProviderConfig" + }, + { + "$ref": "#/components/schemas/OpenAIProviderConfig" + } + ] + } + }, + "required": [ + "providerConfig" + ], + "type": "object" + }, + "TestLlmProviderResponse": { + "properties": { + "modelResults": { + "description": "Per-model test results.", + "items": { + "$ref": "#/components/schemas/ModelTestResult" + }, + "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" + ], + "type": "object" + }, "Thought": { "description": "Detailed thoughts/messages within this step.", "properties": { @@ -4749,6 +5530,7 @@ "RUNNING", "COMPLETED", "FAILED", + "CANCELLED", "DISABLED" ], "type": "string" @@ -4763,6 +5545,61 @@ "Unit": { "type": "object" }, + "UpsertKnowledgeDocumentRequestDto": { + "properties": { + "content": { + "type": "string" + }, + "filename": { + "type": "string" + }, + "pageBoundaries": { + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "scopes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "type": "string" + } + }, + "required": [ + "content", + "filename" + ], + "type": "object" + }, + "UpsertKnowledgeDocumentResponseDto": { + "properties": { + "filename": { + "type": "string" + }, + "message": { + "type": "string" + }, + "numChunks": { + "format": "int32", + "type": "integer" + }, + "success": { + "type": "boolean" + } + }, + "required": [ + "filename", + "message", + "numChunks", + "success" + ], + "type": "object" + }, "UserContext": { "description": "User context, which can affect the behavior of the underlying AI features.", "properties": { @@ -4864,6 +5701,89 @@ "successful" ], "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" + }, + "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" } } }, @@ -4948,6 +5868,72 @@ ] } }, + "/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}/test": { + "post": { + "description": "Tests an existing LLM provider connectivity by its ID.", + "operationId": "testLlmProviderById", + "parameters": [ + { + "in": "path", + "name": "llmProviderId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "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/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy": { "get": { "description": "Returns a list of Users who created any object for this workspace", @@ -4983,10 +5969,10 @@ ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags": { - "get": { - "description": "Returns a list of tags for this workspace", - "operationId": "tags", + "/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", "parameters": [ { "description": "Workspace identifier", @@ -4999,29 +5985,84 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerateDescriptionRequest" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnalyticsCatalogTags" + "$ref": "#/components/schemas/GenerateDescriptionResponse" } } }, "description": "OK" } }, - "summary": "Get Analytics Catalog Tags", + "summary": "Generate Description for Analytics Object", "tags": [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/chat": { + "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateTitle": { "post": { - "description": "(BETA) Combines multiple use cases such as search, create visualizations, ...", - "operationId": "aiChat", + "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": "workspaceId", + "required": true, + "schema": { + "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": "Workspace identifier", @@ -5029,44 +6070,386 @@ "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnalyticsCatalogTags" + } + } + }, + "description": "OK" + } + }, + "summary": "Get Analytics Catalog Tags", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/ai/chat": { + "post": { + "description": "(BETA) Combines multiple use cases such as search, create visualizations, ...", + "operationId": "aiChat", + "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/ChatRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChatResult" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Chat with AI", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/ai/chatHistory": { + "post": { + "description": "(BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history.", + "operationId": "aiChatHistory", + "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/ChatHistoryRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChatHistoryResult" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Get Chat History", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/ai/chatStream": { + "post": { + "description": "(BETA) Combines multiple use cases such as search, create visualizations, ...", + "operationId": "aiChatStream", + "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/ChatRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "text/event-stream": { + "schema": { + "items": { + "$ref": "#/components/schemas/ServerSentEventChatResult" + }, + "type": "array" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Chat with AI", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/ai/chatUsage": { + "get": { + "description": "Returns usage statistics of chat for a user in a workspace.", + "operationId": "aiChatUsage", + "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/ChatUsageResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "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": { + "schema": { + "$ref": "#/components/schemas/GetQualityIssuesResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "Get Quality Issues", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId}": { + "get": { + "description": "Returns the status of a quality issues calculation process identified by process ID.", + "operationId": "getQualityIssuesCalculationStatus", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + { + "in": "path", + "name": "processId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QualityIssuesCalculationStatusResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "Get Quality Issues Calculation Status", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck": { + "post": { + "description": "Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking.", + "operationId": "triggerQualityIssuesCalculation", + "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/TriggerQualityIssuesCalculationResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "Trigger Quality Issues Calculation", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents": { + "get": { + "operationId": "listDocuments", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + { + "in": "query", + "name": "scopes", + "required": false, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + { + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 50, + "format": "int32", + "type": "integer" + } + }, + { + "in": "query", + "name": "pageToken", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatRequest" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ChatResult" + "$ref": "#/components/schemas/ListKnowledgeDocumentsResponseDto" } } }, "description": "OK" } }, - "summary": "(BETA) Chat with AI", "tags": [ - "Smart Functions", "actions" ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/ai/chatHistory": { + }, "post": { - "description": "(BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history.", - "operationId": "aiChatHistory", + "operationId": "createDocument", "parameters": [ { "description": "Workspace identifier", @@ -5083,7 +6466,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ChatHistoryRequest" + "$ref": "#/components/schemas/CreateKnowledgeDocumentRequestDto" } } }, @@ -5094,24 +6477,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ChatHistoryResult" + "$ref": "#/components/schemas/CreateKnowledgeDocumentResponseDto" } } }, "description": "OK" } }, - "summary": "(BETA) Get Chat History", "tags": [ - "Smart Functions", "actions" ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/ai/chatStream": { - "post": { - "description": "(BETA) Combines multiple use cases such as search, create visualizations, ...", - "operationId": "aiChatStream", + }, + "put": { + "operationId": "upsertDocument", "parameters": [ { "description": "Workspace identifier", @@ -5128,7 +6506,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ChatRequest" + "$ref": "#/components/schemas/UpsertKnowledgeDocumentRequestDto" } } }, @@ -5137,29 +6515,23 @@ "responses": { "200": { "content": { - "text/event-stream": { + "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/ServerSentEventChatResult" - }, - "type": "array" + "$ref": "#/components/schemas/UpsertKnowledgeDocumentResponseDto" } } }, "description": "OK" } }, - "summary": "(BETA) Chat with AI", "tags": [ - "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/chatUsage": { - "get": { - "description": "Returns usage statistics of chat for a user in a workspace.", - "operationId": "aiChatUsage", + "/api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents/{filename}": { + "delete": { + "operationId": "deleteDocument", "parameters": [ { "description": "Workspace identifier", @@ -5170,6 +6542,14 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } + }, + { + "in": "path", + "name": "filename", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { @@ -5177,24 +6557,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ChatUsageResponse" + "$ref": "#/components/schemas/DeleteKnowledgeDocumentResponseDto" } } }, "description": "OK" } }, - "summary": "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", + "operationId": "getDocument", "parameters": [ { "description": "Workspace identifier", @@ -5205,6 +6580,14 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } + }, + { + "in": "path", + "name": "filename", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { @@ -5212,24 +6595,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetQualityIssuesResponse" + "$ref": "#/components/schemas/KnowledgeDocumentMetadataDto" } } }, "description": "OK" } }, - "summary": "Get Quality Issues", "tags": [ - "Smart Functions", "actions" ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId}": { - "get": { - "description": "Returns the status of a quality issues calculation process identified by process ID.", - "operationId": "getQualityIssuesCalculationStatus", + }, + "patch": { + "operationId": "patchDocument", "parameters": [ { "description": "Workspace identifier", @@ -5243,36 +6621,43 @@ }, { "in": "path", - "name": "processId", + "name": "filename", "required": true, "schema": { "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchKnowledgeDocumentRequestDto" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QualityIssuesCalculationStatusResponse" + "$ref": "#/components/schemas/KnowledgeDocumentMetadataDto" } } }, "description": "OK" } }, - "summary": "Get Quality Issues Calculation Status", "tags": [ - "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck": { - "post": { - "description": "Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking.", - "operationId": "triggerQualityIssuesCalculation", + "/api/v1/actions/workspaces/{workspaceId}/ai/knowledge/search": { + "get": { + "operationId": "searchKnowledge", "parameters": [ { "description": "Workspace identifier", @@ -5283,6 +6668,45 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } + }, + { + "in": "query", + "name": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "format": "int32", + "type": "integer" + } + }, + { + "in": "query", + "name": "minScore", + "required": false, + "schema": { + "default": 0.0, + "format": "double", + "type": "number" + } + }, + { + "in": "query", + "name": "scopes", + "required": false, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } } ], "responses": { @@ -5290,16 +6714,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TriggerQualityIssuesCalculationResponse" + "$ref": "#/components/schemas/SearchKnowledgeResponseDto" } } }, "description": "OK" } }, - "summary": "Trigger Quality Issues Calculation", "tags": [ - "Smart Functions", "actions" ] } @@ -6689,7 +8111,36 @@ ] } }, - "/api/v1/ailake/database/instance": { + "/api/v1/ailake/database/instances": { + "get": { + "description": "(BETA) Lists database instances in the organization's AI Lake.", + "operationId": "listAiLakeDatabaseInstances", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/DatabaseInstance" + }, + "type": "array" + } + } + }, + "description": "AI Lake database instances successfully retrieved" + } + }, + "summary": "(BETA) List AI Lake Database instances", + "tags": [ + "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", @@ -6735,7 +8186,7 @@ }, "operation-location": { "description": "Operation location URL that can be used for polling.", - "example": "/api/v1/ailake/operation/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "required": true, "schema": { "type": "string" @@ -6757,7 +8208,7 @@ } } }, - "/api/v1/ailake/database/instance/{instanceId}": { + "/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.", "operationId": "deprovisionAiLakeDatabaseInstance", @@ -6801,7 +8252,7 @@ }, "operation-location": { "description": "Operation location URL that can be used for polling.", - "example": "/api/v1/ailake/operation/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "required": true, "schema": { "type": "string" @@ -6859,7 +8310,7 @@ } } }, - "/api/v1/ailake/operation/{operationId}": { + "/api/v1/ailake/operations/{operationId}": { "get": { "description": "(BETA) Retrieves details of a Long Running Operation specified by the operation-id.", "operationId": "getAiLakeOperation", @@ -6908,6 +8359,121 @@ ] } } + }, + "/api/v1/ailake/services": { + "get": { + "description": "(BETA) Lists services configured for the organization's AI Lake. Returns only non-sensitive fields (id, name).", + "operationId": "listAiLakeServices", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ServiceInfo" + }, + "type": "array" + } + } + }, + "description": "AI Lake services successfully retrieved" + } + }, + "summary": "(BETA) List AI Lake services", + "tags": [ + "AI Lake" + ], + "x-gdc-security-info": { + "description": "Permissions required to list AI Lake services.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/ailake/services/{serviceId}/commands/{commandName}/run": { + "post": { + "description": "(BETA) Runs a specific AI Lake service command.", + "operationId": "runAiLakeServiceCommand", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "commandName", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "operation-id", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RunServiceCommandRequest" + } + } + }, + "required": true + }, + "responses": { + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Unit" + } + } + }, + "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": "(BETA) Run an AI Lake services command", + "tags": [ + "AI Lake" + ], + "x-gdc-security-info": { + "description": "Permissions required to run AI Lake service commands.", + "permissions": [ + "MANAGE" + ] + } + } } }, "servers": [ diff --git a/schemas/gooddata-api-client.json b/schemas/gooddata-api-client.json index a0c3f679e..bf6c062a3 100644 --- a/schemas/gooddata-api-client.json +++ b/schemas/gooddata-api-client.json @@ -81,6 +81,13 @@ }, "type": "array" }, + "measureDefinitionOverrides": { + "description": "(EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric's MAQL definition without modifying the stored definition.", + "items": { + "$ref": "#/components/schemas/MetricDefinitionOverride" + }, + "type": "array" + }, "measures": { "description": "Metrics to be computed.", "items": { @@ -4495,9 +4502,9 @@ } }, "required": [ + "dataset", "from", - "to", - "dataset" + "to" ], "type": "object" } @@ -4957,69 +4964,6 @@ ], "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": { - "allTimeDateFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "emptyValueHandling": { - "default": "INCLUDE", - "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE means no filtering effect (default), EXCLUDE removes rows with null dates, ONLY keeps only rows with null dates.", - "enum": [ - "INCLUDE", - "EXCLUDE", - "ONLY" - ], - "type": "string" - }, - "granularity": { - "default": "DAY", - "description": "Date granularity used to resolve the date attribute label for null value checks. Defaults to DAY if not specified.", - "enum": [ - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", - "MINUTE_OF_HOUR", - "HOUR_OF_DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK_OF_YEAR", - "MONTH_OF_YEAR", - "QUARTER_OF_YEAR", - "FISCAL_MONTH", - "FISCAL_QUARTER", - "FISCAL_YEAR" - ], - "example": "DAY", - "type": "string" - }, - "localIdentifier": { - "type": "string" - } - }, - "required": [ - "dataset" - ], - "type": "object" - } - }, - "required": [ - "allTimeDateFilter" - ], - "type": "object" - }, "AlertAfm": { "properties": { "attributes": { @@ -5177,6 +5121,69 @@ }, "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": { + "allTimeDateFilter": { + "properties": { + "applyOnResult": { + "type": "boolean" + }, + "dataset": { + "$ref": "#/components/schemas/AfmObjectIdentifierDataset" + }, + "emptyValueHandling": { + "default": "INCLUDE", + "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE means no filtering effect (default), EXCLUDE removes rows with null dates, ONLY keeps only rows with null dates.", + "enum": [ + "INCLUDE", + "EXCLUDE", + "ONLY" + ], + "type": "string" + }, + "granularity": { + "default": "DAY", + "description": "Date granularity used to resolve the date attribute label for null value checks. Defaults to DAY if not specified.", + "enum": [ + "MINUTE", + "HOUR", + "DAY", + "WEEK", + "MONTH", + "QUARTER", + "YEAR", + "MINUTE_OF_HOUR", + "HOUR_OF_DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK_OF_YEAR", + "MONTH_OF_YEAR", + "QUARTER_OF_YEAR", + "FISCAL_MONTH", + "FISCAL_QUARTER", + "FISCAL_YEAR" + ], + "example": "DAY", + "type": "string" + }, + "localIdentifier": { + "type": "string" + } + }, + "required": [ + "dataset" + ], + "type": "object" + } + }, + "required": [ + "allTimeDateFilter" + ], + "type": "object" + }, "AllowedRelationshipType": { "description": "Allowed relationship type combination.", "properties": { @@ -5316,6 +5323,24 @@ ], "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": { @@ -6065,6 +6090,146 @@ ], "type": "object" }, + "AwsBedrockAccessKeyAuth": { + "allOf": [ + { + "properties": { + "accessKeyId": { + "description": "AWS Access Key ID.", + "maxLength": 255, + "nullable": true, + "type": "string", + "writeOnly": true + }, + "secretAccessKey": { + "description": "AWS Secret Access Key.", + "maxLength": 10000, + "nullable": true, + "type": "string", + "writeOnly": true + }, + "sessionToken": { + "description": "AWS Session Token (for temporary credentials).", + "maxLength": 10000, + "nullable": true, + "type": "string", + "writeOnly": true + }, + "type": { + "description": "Authentication type.", + "enum": [ + "ACCESS_KEY" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "required": [ + "type" + ], + "type": "object" + }, + "AwsBedrockProviderConfig": { + "description": "Configuration for AWS Bedrock provider.", + "properties": { + "auth": { + "$ref": "#/components/schemas/BedrockProviderAuth" + }, + "region": { + "description": "AWS region for Bedrock.", + "example": "us-east-1", + "maxLength": 255, + "type": "string" + }, + "type": { + "description": "Provider type.", + "enum": [ + "AWS_BEDROCK" + ], + "type": "string" + } + }, + "required": [ + "auth", + "region", + "type" + ], + "type": "object" + }, + "AzureFoundryApiKeyAuth": { + "allOf": [ + { + "properties": { + "apiKey": { + "description": "Azure 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" + }, + "AzureFoundryProviderAuth": { + "description": "Authentication configuration.", + "oneOf": [ + { + "$ref": "#/components/schemas/AzureFoundryApiKeyAuth" + } + ], + "type": "object" + }, + "AzureFoundryProviderConfig": { + "description": "Configuration for Azure Foundry provider.", + "properties": { + "auth": { + "$ref": "#/components/schemas/AzureFoundryProviderAuth" + }, + "endpoint": { + "description": "Azure AI inference endpoint URL.", + "example": "https://my-resource.services.ai.azure.com/models", + "maxLength": 255, + "type": "string" + }, + "type": { + "description": "Provider type.", + "enum": [ + "AZURE_FOUNDRY" + ], + "type": "string" + } + }, + "required": [ + "auth", + "endpoint", + "type" + ], + "type": "object" + }, + "BedrockProviderAuth": { + "description": "Authentication configuration.", + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockAccessKeyAuth" + } + ], + "type": "object" + }, "BoundedFilter": { "description": "Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range.", "properties": { @@ -6562,6 +6727,26 @@ ], "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": { @@ -6917,9 +7102,9 @@ } }, "required": [ + "measure", "operator", - "value", - "measure" + "value" ], "type": "object" } @@ -7027,9 +7212,67 @@ }, "type": "object" }, + "CreateKnowledgeDocumentRequestDto": { + "properties": { + "content": { + "type": "string" + }, + "filename": { + "type": "string" + }, + "pageBoundaries": { + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "scopes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "type": "string" + } + }, + "required": [ + "content", + "filename" + ], + "type": "object" + }, + "CreateKnowledgeDocumentResponseDto": { + "properties": { + "filename": { + "type": "string" + }, + "message": { + "type": "string" + }, + "numChunks": { + "format": "int32", + "type": "integer" + }, + "success": { + "type": "boolean" + } + }, + "required": [ + "filename", + "message", + "numChunks", + "success" + ], + "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": { @@ -7096,7 +7339,8 @@ "BAR", "LINE", "PIE", - "COLUMN" + "COLUMN", + "SCATTER" ], "example": "TABLE", "type": "string" @@ -7264,6 +7508,14 @@ "dataSet": { "$ref": "#/components/schemas/IdentifierRef" }, + "emptyValueHandling": { + "enum": [ + "INCLUDE", + "EXCLUDE", + "ONLY" + ], + "type": "string" + }, "from": { "oneOf": [ { @@ -7865,6 +8117,9 @@ }, { "$ref": "#/components/schemas/RelativeDateFilter" + }, + { + "$ref": "#/components/schemas/AllTimeDateFilter" } ], "type": "object" @@ -8006,6 +8261,27 @@ }, "DeclarativeAnalyticalDashboard": { "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/JsonNode" }, @@ -8393,7 +8669,7 @@ }, "createdAt": { "description": "Time of the entity creation.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -8415,7 +8691,7 @@ }, "modifiedAt": { "description": "Time of the last entity modification.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -8780,7 +9056,7 @@ }, "createdAt": { "description": "Time of the entity creation.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -8802,7 +9078,7 @@ }, "modifiedAt": { "description": "Time of the last entity modification.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -9270,7 +9546,7 @@ "properties": { "createdAt": { "description": "Time of the entity creation.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -9292,7 +9568,7 @@ }, "modifiedAt": { "description": "Time of the last entity modification.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -9964,12 +10240,33 @@ }, "DeclarativeMetric": { "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/JsonNode" }, "createdAt": { "description": "Time of the entity creation.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -10001,7 +10298,7 @@ }, "modifiedAt": { "description": "Time of the last entity modification.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -10540,6 +10837,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -10582,7 +10880,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "example": "TIMEZONE", "type": "string" @@ -10608,6 +10907,8 @@ "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", + "WRITE_KNOWLEDGE_DOCUMENTS", + "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], @@ -11061,12 +11362,33 @@ }, "DeclarativeVisualizationObject": { "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/JsonNode" }, "createdAt": { "description": "Time of the entity creation.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -11093,7 +11415,7 @@ }, "modifiedAt": { "description": "Time of the last entity modification.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -11417,6 +11739,8 @@ "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", + "WRITE_KNOWLEDGE_DOCUMENTS", + "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], @@ -11533,6 +11857,21 @@ ], "type": "object" }, + "DeleteKnowledgeDocumentResponseDto": { + "properties": { + "message": { + "type": "string" + }, + "success": { + "type": "boolean" + } + }, + "required": [ + "message", + "success" + ], + "type": "object" + }, "DependentEntitiesGraph": { "properties": { "edges": { @@ -11602,6 +11941,15 @@ "$ref": "#/components/schemas/EntityIdentifier" }, "type": "array" + }, + "relation": { + "default": "DEPENDENTS", + "description": "Entity relation for graph traversal from the entry points. DEPENDENTS returns entities that depend on the entry points. DEPENDENCIES returns entities that the entry points depend on.", + "enum": [ + "DEPENDENTS", + "DEPENDENCIES" + ], + "type": "string" } }, "required": [ @@ -12550,10 +12898,10 @@ "$ref": "#/components/schemas/AbsoluteDateFilter" }, { - "$ref": "#/components/schemas/AllTimeDateFilter" + "$ref": "#/components/schemas/RelativeDateFilter" }, { - "$ref": "#/components/schemas/RelativeDateFilter" + "$ref": "#/components/schemas/AllTimeDateFilter" }, { "$ref": "#/components/schemas/NegativeAttributeFilter" @@ -12579,6 +12927,31 @@ ], "type": "object" }, + "ForecastConfig": { + "description": "Forecast configuration.", + "properties": { + "confidenceLevel": { + "description": "Confidence interval boundary value.", + "format": "float", + "type": "number" + }, + "forecastPeriod": { + "description": "Number of future periods that should be forecasted", + "format": "int32", + "type": "integer" + }, + "seasonal": { + "description": "Whether the input data is seasonal", + "type": "boolean" + } + }, + "required": [ + "confidenceLevel", + "forecastPeriod", + "seasonal" + ], + "type": "object" + }, "ForecastRequest": { "properties": { "confidenceLevel": { @@ -12714,6 +13087,43 @@ }, "type": "object" }, + "GenerateDescriptionRequest": { + "properties": { + "objectId": { + "description": "Identifier of the object to describe", + "type": "string" + }, + "objectType": { + "description": "Type of the object to describe. One of: visualization, dashboard, metric, fact, attribute", + "enum": [ + "Visualization", + "Dashboard", + "Metric", + "Fact", + "Attribute" + ], + "type": "string" + } + }, + "required": [ + "objectId", + "objectType" + ], + "type": "object" + }, + "GenerateDescriptionResponse": { + "properties": { + "description": { + "description": "Generated description of the requested object", + "type": "string" + }, + "note": { + "description": "Additional note with details in case generation was not performed", + "type": "string" + } + }, + "type": "object" + }, "GenerateLdmRequest": { "description": "A request containing all information needed for generation of logical model.", "properties": { @@ -12819,6 +13229,43 @@ }, "type": "object" }, + "GenerateTitleRequest": { + "properties": { + "objectId": { + "description": "Identifier of the object to title", + "type": "string" + }, + "objectType": { + "description": "Type of the object to title. Matches chat-search object types.", + "enum": [ + "Visualization", + "Dashboard", + "Metric", + "Fact", + "Attribute" + ], + "type": "string" + } + }, + "required": [ + "objectId", + "objectType" + ], + "type": "object" + }, + "GenerateTitleResponse": { + "properties": { + "note": { + "description": "Additional note with details in case generation was not performed", + "type": "string" + }, + "title": { + "description": "Generated title of the requested object", + "type": "string" + } + }, + "type": "object" + }, "GeoAreaConfig": { "description": "Configuration specific to geo area labels.", "properties": { @@ -12869,6 +13316,7 @@ "SYNCING", "COMPLETED", "FAILED", + "CANCELLED", "NOT_FOUND", "DISABLED" ], @@ -13621,6 +14069,26 @@ "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": { @@ -13634,6 +14102,7 @@ }, "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}", @@ -13645,6 +14114,7 @@ }, "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}", @@ -13740,6 +14210,17 @@ ], "type": "object" }, + "certifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "createdBy": { "properties": { "data": { @@ -14353,6 +14834,7 @@ }, "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}", @@ -14364,6 +14846,7 @@ }, "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}", @@ -15376,6 +15859,7 @@ }, "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}", @@ -15463,6 +15947,7 @@ }, "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}", @@ -17362,6 +17847,7 @@ }, "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}", @@ -17373,6 +17859,7 @@ }, "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}", @@ -19076,6 +19563,7 @@ }, "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}", @@ -19087,6 +19575,7 @@ }, "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}", @@ -23047,57 +23536,334 @@ ], "type": "object" }, - "JsonApiMemoryItemIn": { - "description": "JSON:API representation of memoryItem entity.", + "JsonApiLlmProviderIn": { + "description": "LLM Provider configuration for connecting to LLM services.", "properties": { "attributes": { "properties": { - "areRelationsValid": { - "type": "boolean" + "defaultModelId": { + "description": "ID of the default model to use from the models list.", + "maxLength": 255, + "nullable": true, + "type": "string" }, "description": { + "description": "Description of the LLM Provider.", "maxLength": 10000, + "nullable": true, "type": "string" }, - "instruction": { - "description": "The text that will be injected into the system prompt", + "models": { + "description": "List of LLM models available for this provider.", + "items": { + "description": "LLM Model configuration (id, family) within a provider.", + "properties": { + "family": { + "description": "Family of LLM models.", + "enum": [ + "OPENAI", + "ANTHROPIC", + "META", + "MISTRAL", + "AMAZON", + "GOOGLE", + "COHERE" + ], + "type": "string" + }, + "id": { + "description": "Unique identifier of the model (e.g., gpt-5.3, claude-4.6).", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "family", + "id" + ], + "type": "object" + }, + "nullable": true, + "type": "array" + }, + "name": { "maxLength": 255, + "nullable": true, "type": "string" }, - "isDisabled": { - "description": "Whether memory item is disabled", - "type": "boolean" + "providerConfig": { + "description": "Provider-specific configuration including authentication.", + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockProviderConfig" + }, + { + "$ref": "#/components/schemas/AzureFoundryProviderConfig" + }, + { + "$ref": "#/components/schemas/OpenAIProviderConfig" + } + ] + } + }, + "required": [ + "models", + "providerConfig" + ], + "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": [ + "llmProvider" + ], + "example": "llmProvider", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiLlmProviderInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiLlmProviderIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiLlmProviderOut": { + "description": "LLM Provider configuration for connecting to LLM services.", + "properties": { + "attributes": { + "properties": { + "defaultModelId": { + "description": "ID of the default model to use from the models list.", + "maxLength": 255, + "nullable": true, + "type": "string" }, - "keywords": { - "description": "Set of unique strings used for semantic similarity filtering", + "description": { + "description": "Description of the LLM Provider.", + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "models": { + "description": "List of LLM models available for this provider.", "items": { - "type": "string" + "description": "LLM Model configuration (id, family) within a provider.", + "properties": { + "family": { + "description": "Family of LLM models.", + "enum": [ + "OPENAI", + "ANTHROPIC", + "META", + "MISTRAL", + "AMAZON", + "GOOGLE", + "COHERE" + ], + "type": "string" + }, + "id": { + "description": "Unique identifier of the model (e.g., gpt-5.3, claude-4.6).", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "family", + "id" + ], + "type": "object" }, + "nullable": true, "type": "array" }, - "strategy": { - "description": "Strategy defining when the memory item should be applied", - "enum": [ - "ALWAYS", - "AUTO" - ], + "name": { + "maxLength": 255, + "nullable": true, "type": "string" }, - "tags": { + "providerConfig": { + "description": "Provider-specific configuration including authentication.", + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockProviderConfig" + }, + { + "$ref": "#/components/schemas/AzureFoundryProviderConfig" + }, + { + "$ref": "#/components/schemas/OpenAIProviderConfig" + } + ] + } + }, + "required": [ + "models", + "providerConfig" + ], + "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": [ + "llmProvider" + ], + "example": "llmProvider", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiLlmProviderOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiLlmProviderOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiLlmProviderOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiLlmProviderOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiLlmProviderOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiLlmProviderPatch": { + "description": "LLM Provider configuration for connecting to LLM services.", + "properties": { + "attributes": { + "properties": { + "defaultModelId": { + "description": "ID of the default model to use from the models list.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "description": { + "description": "Description of the LLM Provider.", + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "models": { + "description": "List of LLM models available for this provider.", "items": { - "type": "string" + "description": "LLM Model configuration (id, family) within a provider.", + "properties": { + "family": { + "description": "Family of LLM models.", + "enum": [ + "OPENAI", + "ANTHROPIC", + "META", + "MISTRAL", + "AMAZON", + "GOOGLE", + "COHERE" + ], + "type": "string" + }, + "id": { + "description": "Unique identifier of the model (e.g., gpt-5.3, claude-4.6).", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "family", + "id" + ], + "type": "object" }, + "nullable": true, "type": "array" }, - "title": { + "name": { "maxLength": 255, + "nullable": true, "type": "string" + }, + "providerConfig": { + "description": "Provider-specific configuration including authentication.", + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockProviderConfig" + }, + { + "$ref": "#/components/schemas/AzureFoundryProviderConfig" + }, + { + "$ref": "#/components/schemas/OpenAIProviderConfig" + } + ] } }, - "required": [ - "instruction", - "strategy" - ], "type": "object" }, "id": { @@ -23109,9 +23875,9 @@ "type": { "description": "Object type", "enum": [ - "memoryItem" + "llmProvider" ], - "example": "memoryItem", + "example": "llmProvider", "type": "string" } }, @@ -23122,10 +23888,10 @@ ], "type": "object" }, - "JsonApiMemoryItemInDocument": { + "JsonApiLlmProviderPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiMemoryItemIn" + "$ref": "#/components/schemas/JsonApiLlmProviderPatch" } }, "required": [ @@ -23133,7 +23899,7 @@ ], "type": "object" }, - "JsonApiMemoryItemOut": { + "JsonApiMemoryItemIn": { "description": "JSON:API representation of memoryItem entity.", "properties": { "attributes": { @@ -23141,13 +23907,6 @@ "areRelationsValid": { "type": "boolean" }, - "createdAt": { - "description": "Time of the entity creation.", - "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" @@ -23168,13 +23927,108 @@ }, "type": "array" }, - "modifiedAt": { - "description": "Time of the last entity modification.", - "format": "date-time", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, + "strategy": { + "description": "Strategy defining when the memory item should be applied", + "enum": [ + "ALWAYS", + "AUTO" + ], + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "instruction", + "strategy" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "memoryItem" + ], + "example": "memoryItem", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiMemoryItemInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiMemoryItemIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiMemoryItemOut": { + "description": "JSON:API representation of memoryItem entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "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" + }, + "instruction": { + "description": "The text that will be injected into the system prompt", + "maxLength": 255, + "type": "string" + }, + "isDisabled": { + "description": "Whether memory item is disabled", + "type": "boolean" + }, + "keywords": { + "description": "Set of unique strings used for semantic similarity filtering", + "items": { + "type": "string" + }, + "type": "array" + }, + "modifiedAt": { + "description": "Time of the last entity modification.", + "example": "2023-07-20 12:30", + "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, "strategy": { "description": "Strategy defining when the memory item should be applied", "enum": [ @@ -23629,6 +24483,26 @@ "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": { "properties": { "format": { @@ -23657,6 +24531,7 @@ }, "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}", @@ -23674,6 +24549,7 @@ }, "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}", @@ -23740,6 +24616,17 @@ ], "type": "object" }, + "certifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "createdBy": { "properties": { "data": { @@ -25076,6 +25963,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -25118,7 +26006,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -25173,6 +26062,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -25215,7 +26105,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -25310,6 +26201,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -25352,7 +26244,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -26813,6 +27706,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -26855,7 +27749,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -26910,6 +27805,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -26952,7 +27848,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -27149,6 +28046,26 @@ "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": { @@ -27162,6 +28079,7 @@ }, "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}", @@ -27176,6 +28094,7 @@ }, "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}", @@ -27242,6 +28161,17 @@ ], "type": "object" }, + "certifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "createdBy": { "properties": { "data": { @@ -28888,6 +29818,8 @@ "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", + "WRITE_KNOWLEDGE_DOCUMENTS", + "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], @@ -29128,6 +30060,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -29170,7 +30103,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -29225,6 +30159,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -29267,7 +30202,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -29388,6 +30324,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -29430,7 +30367,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -29485,6 +30423,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -29527,7 +30466,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -29699,6 +30639,105 @@ ], "type": "object" }, + "KnowledgeDocumentMetadataDto": { + "properties": { + "createdAt": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "filename": { + "type": "string" + }, + "isDisabled": { + "type": "boolean" + }, + "numChunks": { + "format": "int32", + "type": "integer" + }, + "scopes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "updatedAt": { + "type": "string" + }, + "updatedBy": { + "type": "string" + }, + "workspaceId": { + "type": "string" + } + }, + "required": [ + "createdAt", + "createdBy", + "filename", + "numChunks", + "scopes", + "updatedAt", + "updatedBy" + ], + "type": "object" + }, + "KnowledgeSearchResultDto": { + "properties": { + "chunkIndex": { + "format": "int32", + "type": "integer" + }, + "content": { + "type": "string" + }, + "filename": { + "type": "string" + }, + "pageNumbers": { + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "scopes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "score": { + "format": "float", + "type": "number" + }, + "title": { + "type": "string" + }, + "totalChunks": { + "format": "int32", + "type": "integer" + }, + "workspaceId": { + "type": "string" + } + }, + "required": [ + "chunkIndex", + "content", + "filename", + "pageNumbers", + "scopes", + "score", + "totalChunks" + ], + "type": "object" + }, "LabelIdentifier": { "description": "A label identifier.", "properties": { @@ -29723,6 +30762,27 @@ ], "type": "object" }, + "ListKnowledgeDocumentsResponseDto": { + "properties": { + "documents": { + "items": { + "$ref": "#/components/schemas/KnowledgeDocumentMetadataDto" + }, + "type": "array" + }, + "nextPageToken": { + "type": "string" + }, + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "documents" + ], + "type": "object" + }, "ListLinks": { "allOf": [ { @@ -29740,6 +30800,59 @@ } ] }, + "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" + ], + "type": "string" + }, + "id": { + "description": "Unique identifier of the model (e.g., gpt-5.3, claude-4.6).", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "family", + "id" + ], + "type": "object" + }, + "LlmProviderAuth": { + "properties": { + "type": { + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "LlmProviderConfig": { + "description": "Provider configuration to test.", + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockProviderConfig" + }, + { + "$ref": "#/components/schemas/AzureFoundryProviderConfig" + }, + { + "$ref": "#/components/schemas/OpenAIProviderConfig" + } + ] + }, "LocalIdentifier": { "properties": { "format": { @@ -29821,9 +30934,9 @@ } }, "required": [ + "label", "literal", - "matchType", - "label" + "matchType" ], "type": "object" } @@ -30060,6 +31173,22 @@ ], "type": "object" }, + "MetricDefinitionOverride": { + "description": "(EXPERIMENTAL) Override for a catalog metric definition.", + "properties": { + "definition": { + "$ref": "#/components/schemas/InlineMeasureDefinition" + }, + "item": { + "$ref": "#/components/schemas/AfmObjectIdentifierCore" + } + }, + "required": [ + "definition", + "item" + ], + "type": "object" + }, "MetricRecord": { "properties": { "formattedValue": { @@ -30146,6 +31275,29 @@ ], "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": { @@ -30165,8 +31317,8 @@ } }, "required": [ - "notIn", - "label" + "label", + "notIn" ], "type": "object" } @@ -30377,6 +31529,75 @@ }, "type": "object" }, + "OpenAIProviderConfig": { + "description": "Configuration for OpenAI provider.", + "properties": { + "auth": { + "$ref": "#/components/schemas/OpenAiProviderAuth" + }, + "baseUrl": { + "default": "https://api.openai.com", + "description": "Custom base URL for OpenAI API.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "organization": { + "description": "OpenAI organization ID.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "type": { + "description": "Provider type.", + "enum": [ + "OPENAI" + ], + "type": "string" + } + }, + "required": [ + "auth", + "type" + ], + "type": "object" + }, + "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" + }, "Operation": { "description": "Represents a Long-Running Operation: a process that takes some time to complete.", "discriminator": { @@ -30393,10 +31614,11 @@ "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", + "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", "enum": [ "provision-database", - "deprovision-database" + "deprovision-database", + "run-service-command" ], "type": "string" }, @@ -30690,6 +31912,23 @@ ], "type": "object" }, + "PatchKnowledgeDocumentRequestDto": { + "properties": { + "isDisabled": { + "type": "boolean" + }, + "scopes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "type": "string" + } + }, + "type": "object" + }, "PdfTableStyle": { "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", @@ -31168,6 +32407,7 @@ "SYNCING", "COMPLETED", "FAILED", + "CANCELLED", "NOT_FOUND", "DISABLED" ], @@ -31286,9 +32526,9 @@ }, "required": [ "from", + "measure", "operator", - "to", - "measure" + "to" ], "type": "object" } @@ -31732,10 +32972,10 @@ } }, "required": [ + "dataset", "from", "granularity", - "to", - "dataset" + "to" ], "type": "object" } @@ -31824,6 +33064,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -31866,7 +33107,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "example": "TIMEZONE", "type": "string" @@ -32016,6 +33258,8 @@ "type": "string" }, "kid": { + "maxLength": 255, + "pattern": "^[^.]", "type": "string" }, "kty": { @@ -32074,6 +33318,25 @@ ], "type": "object" }, + "RunServiceCommandRequest": { + "description": "Request to run an AI Lake Service Command", + "properties": { + "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" + }, + "payload": { + "$ref": "#/components/schemas/JsonNode" + } + }, + "type": "object" + }, "RunningSection": { "description": "Footer section of the slide", "nullable": true, @@ -32216,6 +33479,24 @@ ], "type": "object" }, + "SearchKnowledgeResponseDto": { + "properties": { + "results": { + "items": { + "$ref": "#/components/schemas/KnowledgeSearchResultDto" + }, + "type": "array" + }, + "statistics": { + "$ref": "#/components/schemas/SearchStatisticsDto" + } + }, + "required": [ + "results", + "statistics" + ], + "type": "object" + }, "SearchRelationshipObject": { "properties": { "sourceObjectId": { @@ -32453,6 +33734,23 @@ ], "type": "object" }, + "SearchStatisticsDto": { + "properties": { + "averageSimilarityScore": { + "format": "float", + "type": "number" + }, + "totalResults": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "averageSimilarityScore", + "totalResults" + ], + "type": "object" + }, "SectionSlideTemplate": { "description": "Settings for section slide.", "nullable": true, @@ -32474,6 +33772,61 @@ "ServerSentEventChatResult": { "type": "object" }, + "ServiceInfo": { + "description": "Non-sensitive metadata for an AI Lake pipeline", + "properties": { + "name": { + "description": "Human-readable name of the service", + "type": "string" + }, + "serviceId": { + "description": "Internal identifier for the service configuration (UUID)", + "type": "string" + } + }, + "required": [ + "name", + "serviceId" + ], + "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" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, "Settings": { "description": "Additional settings.", "properties": { @@ -33268,6 +34621,59 @@ ], "type": "object" }, + "TestLlmProviderDefinitionRequest": { + "properties": { + "models": { + "description": "Models to test.", + "items": { + "$ref": "#/components/schemas/LlmModel" + }, + "type": "array" + }, + "providerConfig": { + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockProviderConfig" + }, + { + "$ref": "#/components/schemas/AzureFoundryProviderConfig" + }, + { + "$ref": "#/components/schemas/OpenAIProviderConfig" + } + ] + } + }, + "required": [ + "providerConfig" + ], + "type": "object" + }, + "TestLlmProviderResponse": { + "properties": { + "modelResults": { + "description": "Per-model test results.", + "items": { + "$ref": "#/components/schemas/ModelTestResult" + }, + "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" + ], + "type": "object" + }, "TestNotification": { "allOf": [ { @@ -33508,6 +34914,7 @@ "RUNNING", "COMPLETED", "FAILED", + "CANCELLED", "DISABLED" ], "type": "string" @@ -33522,6 +34929,61 @@ "Unit": { "type": "object" }, + "UpsertKnowledgeDocumentRequestDto": { + "properties": { + "content": { + "type": "string" + }, + "filename": { + "type": "string" + }, + "pageBoundaries": { + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "scopes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "type": "string" + } + }, + "required": [ + "content", + "filename" + ], + "type": "object" + }, + "UpsertKnowledgeDocumentResponseDto": { + "properties": { + "filename": { + "type": "string" + }, + "message": { + "type": "string" + }, + "numChunks": { + "format": "int32", + "type": "integer" + }, + "success": { + "type": "boolean" + } + }, + "required": [ + "filename", + "message", + "numChunks", + "success" + ], + "type": "object" + }, "UserAssignee": { "description": "List of users", "properties": { @@ -33836,6 +35298,8 @@ "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", + "WRITE_KNOWLEDGE_DOCUMENTS", + "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], @@ -33860,6 +35324,8 @@ "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", + "WRITE_KNOWLEDGE_DOCUMENTS", + "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], @@ -34048,6 +35514,24 @@ ], "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" + }, "Webhook": { "allOf": [ { @@ -34291,6 +35775,71 @@ ], "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" + }, "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, @@ -34409,6 +35958,8 @@ "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", + "WRITE_KNOWLEDGE_DOCUMENTS", + "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], @@ -34426,6 +35977,8 @@ "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", + "WRITE_KNOWLEDGE_DOCUMENTS", + "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], @@ -34811,6 +36364,72 @@ ] } }, + "/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}/test": { + "post": { + "description": "Tests an existing LLM provider connectivity by its ID.", + "operationId": "testLlmProviderById", + "parameters": [ + { + "in": "path", + "name": "llmProviderId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "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/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.", @@ -36558,6 +38177,96 @@ ] } }, + "/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", + "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/GenerateDescriptionRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerateDescriptionResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "Generate Description for Analytics Object", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/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", + "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/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", @@ -36879,6 +38588,352 @@ ] } }, + "/api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents": { + "get": { + "operationId": "listDocuments", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + { + "in": "query", + "name": "scopes", + "required": false, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + { + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 50, + "format": "int32", + "type": "integer" + } + }, + { + "in": "query", + "name": "pageToken", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListKnowledgeDocumentsResponseDto" + } + } + }, + "description": "OK" + } + }, + "tags": [ + "actions" + ] + }, + "post": { + "operationId": "createDocument", + "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/CreateKnowledgeDocumentRequestDto" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateKnowledgeDocumentResponseDto" + } + } + }, + "description": "OK" + } + }, + "tags": [ + "actions" + ] + }, + "put": { + "operationId": "upsertDocument", + "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/UpsertKnowledgeDocumentRequestDto" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpsertKnowledgeDocumentResponseDto" + } + } + }, + "description": "OK" + } + }, + "tags": [ + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/ai/knowledge/documents/{filename}": { + "delete": { + "operationId": "deleteDocument", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + { + "in": "path", + "name": "filename", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteKnowledgeDocumentResponseDto" + } + } + }, + "description": "OK" + } + }, + "tags": [ + "actions" + ] + }, + "get": { + "operationId": "getDocument", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + { + "in": "path", + "name": "filename", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KnowledgeDocumentMetadataDto" + } + } + }, + "description": "OK" + } + }, + "tags": [ + "actions" + ] + }, + "patch": { + "operationId": "patchDocument", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + { + "in": "path", + "name": "filename", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchKnowledgeDocumentRequestDto" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KnowledgeDocumentMetadataDto" + } + } + }, + "description": "OK" + } + }, + "tags": [ + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/ai/knowledge/search": { + "get": { + "operationId": "searchKnowledge", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + { + "in": "query", + "name": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 10, + "format": "int32", + "type": "integer" + } + }, + { + "in": "query", + "name": "minScore", + "required": false, + "schema": { + "default": 0.0, + "format": "double", + "type": "number" + } + }, + { + "in": "query", + "name": "scopes", + "required": false, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchKnowledgeResponseDto" + } + } + }, + "description": "OK" + } + }, + "tags": [ + "actions" + ] + } + }, "/api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy": { "get": { "description": "Returns a list of Users who created any memory item for this workspace", @@ -40106,6 +42161,48 @@ } } }, + "/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", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SetCertificationRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + } + }, + "summary": "Set Certification", + "tags": [ + "actions", + "Certification" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/actions/workspaces/{workspaceId}/translations": { "get": { "description": "Provides a list of effective translation tags.", @@ -40417,7 +42514,36 @@ ] } }, - "/api/v1/ailake/database/instance": { + "/api/v1/ailake/database/instances": { + "get": { + "description": "(BETA) Lists database instances in the organization's AI Lake.", + "operationId": "listAiLakeDatabaseInstances", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/DatabaseInstance" + }, + "type": "array" + } + } + }, + "description": "AI Lake database instances successfully retrieved" + } + }, + "summary": "(BETA) List AI Lake Database instances", + "tags": [ + "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", @@ -40463,7 +42589,7 @@ }, "operation-location": { "description": "Operation location URL that can be used for polling.", - "example": "/api/v1/ailake/operation/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "required": true, "schema": { "type": "string" @@ -40485,7 +42611,7 @@ } } }, - "/api/v1/ailake/database/instance/{instanceId}": { + "/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.", "operationId": "deprovisionAiLakeDatabaseInstance", @@ -40529,7 +42655,208 @@ }, "operation-location": { "description": "Operation location URL that can be used for polling.", - "example": "/api/v1/ailake/operation/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + } + } + } + }, + "summary": "(BETA) Delete an existing AILake Database instance", + "tags": [ + "AI Lake" + ], + "x-gdc-security-info": { + "description": "Permissions required to provision an AI Lake database instance.", + "permissions": [ + "MANAGE" + ] + } + }, + "get": { + "description": "(BETA) Retrieve details of the specified AI Lake database instance in the organization's AI Lake.", + "operationId": "getAiLakeDatabaseInstance", + "parameters": [ + { + "in": "path", + "name": "instanceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DatabaseInstance" + } + } + }, + "description": "AI Lake database instance successfully retrieved" + } + }, + "summary": "(BETA) Get the specified AILake Database instance", + "tags": [ + "AI Lake" + ], + "x-gdc-security-info": { + "description": "Permissions required to get an AI Lake database instance.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/ailake/operations/{operationId}": { + "get": { + "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": "operationId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/FailedOperation" + }, + { + "$ref": "#/components/schemas/PendingOperation" + }, + { + "$ref": "#/components/schemas/SucceededOperation" + } + ] + } + } + }, + "description": "AI Lake Long Running Operation details successfully retrieved" + } + }, + "summary": "(BETA) Get Long Running Operation details", + "tags": [ + "AI Lake" + ], + "x-gdc-security-info": { + "description": "Permissions required to get details of a Long Running Operation.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/ailake/services": { + "get": { + "description": "(BETA) Lists services configured for the organization's AI Lake. Returns only non-sensitive fields (id, name).", + "operationId": "listAiLakeServices", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ServiceInfo" + }, + "type": "array" + } + } + }, + "description": "AI Lake services successfully retrieved" + } + }, + "summary": "(BETA) List AI Lake services", + "tags": [ + "AI Lake" + ], + "x-gdc-security-info": { + "description": "Permissions required to list AI Lake services.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/ailake/services/{serviceId}/commands/{commandName}/run": { + "post": { + "description": "(BETA) Runs a specific AI Lake service command.", + "operationId": "runAiLakeServiceCommand", + "parameters": [ + { + "in": "path", + "name": "serviceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "commandName", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "operation-id", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RunServiceCommandRequest" + } + } + }, + "required": true + }, + "responses": { + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Unit" + } + } + }, + "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" @@ -40539,98 +42866,12 @@ } } }, - "summary": "(BETA) Delete an existing AILake Database instance", + "summary": "(BETA) Run an AI Lake services command", "tags": [ "AI Lake" ], "x-gdc-security-info": { - "description": "Permissions required to provision an AI Lake database instance.", - "permissions": [ - "MANAGE" - ] - } - }, - "get": { - "description": "(BETA) Retrieve details of the specified AI Lake database instance in the organization's AI Lake.", - "operationId": "getAiLakeDatabaseInstance", - "parameters": [ - { - "in": "path", - "name": "instanceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DatabaseInstance" - } - } - }, - "description": "AI Lake database instance successfully retrieved" - } - }, - "summary": "(BETA) Get the specified AILake Database instance", - "tags": [ - "AI Lake" - ], - "x-gdc-security-info": { - "description": "Permissions required to get an AI Lake database instance.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/ailake/operation/{operationId}": { - "get": { - "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": "operationId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/FailedOperation" - }, - { - "$ref": "#/components/schemas/PendingOperation" - }, - { - "$ref": "#/components/schemas/SucceededOperation" - } - ] - } - } - }, - "description": "AI Lake Long Running Operation details successfully retrieved" - } - }, - "summary": "(BETA) Get Long Running Operation details", - "tags": [ - "AI Lake" - ], - "x-gdc-security-info": { - "description": "Permissions required to get details of a Long Running Operation.", + "description": "Permissions required to run AI Lake service commands.", "permissions": [ "MANAGE" ] @@ -43524,7 +45765,7 @@ "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;provider==LLMProviderValue", + "example": "title==someString;provider==LlmEndpointProviderValue", "in": "query", "name": "filter", "schema": { @@ -43638,7 +45879,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;provider==LLMProviderValue", + "example": "title==someString;provider==LlmEndpointProviderValue", "in": "query", "name": "filter", "schema": { @@ -43665,7 +45906,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;provider==LLMProviderValue", + "example": "title==someString;provider==LlmEndpointProviderValue", "in": "query", "name": "filter", "schema": { @@ -43705,7 +45946,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;provider==LLMProviderValue", + "example": "title==someString;provider==LlmEndpointProviderValue", "in": "query", "name": "filter", "schema": { @@ -43760,7 +46001,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;provider==LLMProviderValue", + "example": "title==someString;provider==LlmEndpointProviderValue", "in": "query", "name": "filter", "schema": { @@ -43808,6 +46049,298 @@ ] } }, + "/api/v1/entities/llmProviders": { + "get": { + "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;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": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all LLM Provider entities", + "tags": [ + "LLM Providers", + "entities", + "organization-model-controller" + ] + }, + "post": { + "description": "LLM Provider - connection configuration for LLM services", + "operationId": "createEntity@LlmProviders", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post LLM Provider entities", + "tags": [ + "LLM Providers", + "entities", + "organization-model-controller" + ] + } + }, + "/api/v1/entities/llmProviders/{id}": { + "delete": { + "operationId": "deleteEntity@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;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete LLM Provider entity", + "tags": [ + "LLM Providers", + "entities", + "organization-model-controller" + ] + }, + "get": { + "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;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get LLM Provider entity", + "tags": [ + "LLM Providers", + "entities", + "organization-model-controller" + ] + }, + "patch": { + "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;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch LLM Provider entity", + "tags": [ + "LLM Providers", + "entities", + "organization-model-controller" + ] + }, + "put": { + "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;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "PUT LLM Provider entity", + "tags": [ + "LLM Providers", + "entities", + "organization-model-controller" + ] + } + }, "/api/v1/entities/notificationChannelIdentifiers": { "get": { "operationId": "getAllEntities@NotificationChannelIdentifiers", @@ -47310,7 +49843,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", "explode": false, "in": "query", "name": "include", @@ -47328,6 +49861,7 @@ "dashboardPlugins", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -47423,7 +49957,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", "explode": false, "in": "query", "name": "include", @@ -47441,6 +49975,7 @@ "dashboardPlugins", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -47677,7 +50212,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", "explode": false, "in": "query", "name": "include", @@ -47695,6 +50230,7 @@ "dashboardPlugins", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -47797,7 +50333,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", "explode": false, "in": "query", "name": "include", @@ -47815,6 +50351,7 @@ "dashboardPlugins", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -47899,7 +50436,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", "explode": false, "in": "query", "name": "include", @@ -47917,6 +50454,7 @@ "dashboardPlugins", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -55457,7 +57995,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -55473,6 +58011,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -55566,7 +58105,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -55582,6 +58121,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -55816,7 +58356,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -55832,6 +58372,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -55932,7 +58473,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -55948,6 +58489,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -56032,7 +58574,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -56048,6 +58590,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -56788,7 +59331,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -56804,6 +59347,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -56897,7 +59441,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -56913,6 +59457,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -57147,7 +59692,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -57163,6 +59708,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -57263,7 +59809,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -57279,6 +59825,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -57363,7 +59910,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -57379,6 +59926,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" diff --git a/schemas/gooddata-automation-client.json b/schemas/gooddata-automation-client.json index 6c6a5a1de..cb4e6ec33 100644 --- a/schemas/gooddata-automation-client.json +++ b/schemas/gooddata-automation-client.json @@ -35,6 +35,13 @@ }, "type": "array" }, + "measureDefinitionOverrides": { + "description": "(EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric's MAQL definition without modifying the stored definition.", + "items": { + "$ref": "#/components/schemas/MetricDefinitionOverride" + }, + "type": "array" + }, "measures": { "description": "Metrics to be computed.", "items": { @@ -61,6 +68,16 @@ "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": { "example": "2020-07-01 18:23", "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", @@ -76,9 +93,9 @@ } }, "required": [ + "dataset", "from", - "to", - "dataset" + "to" ], "type": "object" } @@ -548,6 +565,69 @@ }, "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": { + "allTimeDateFilter": { + "properties": { + "applyOnResult": { + "type": "boolean" + }, + "dataset": { + "$ref": "#/components/schemas/AfmObjectIdentifierDataset" + }, + "emptyValueHandling": { + "default": "INCLUDE", + "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE means no filtering effect (default), EXCLUDE removes rows with null dates, ONLY keeps only rows with null dates.", + "enum": [ + "INCLUDE", + "EXCLUDE", + "ONLY" + ], + "type": "string" + }, + "granularity": { + "default": "DAY", + "description": "Date granularity used to resolve the date attribute label for null value checks. Defaults to DAY if not specified.", + "enum": [ + "MINUTE", + "HOUR", + "DAY", + "WEEK", + "MONTH", + "QUARTER", + "YEAR", + "MINUTE_OF_HOUR", + "HOUR_OF_DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK_OF_YEAR", + "MONTH_OF_YEAR", + "QUARTER_OF_YEAR", + "FISCAL_MONTH", + "FISCAL_QUARTER", + "FISCAL_YEAR" + ], + "example": "DAY", + "type": "string" + }, + "localIdentifier": { + "type": "string" + } + }, + "required": [ + "dataset" + ], + "type": "object" + } + }, + "required": [ + "allTimeDateFilter" + ], + "type": "object" + }, "AnomalyDetection": { "properties": { "dataset": { @@ -1110,9 +1190,9 @@ } }, "required": [ + "measure", "operator", - "value", - "measure" + "value" ], "type": "object" } @@ -1301,6 +1381,14 @@ "dataSet": { "$ref": "#/components/schemas/IdentifierRef" }, + "emptyValueHandling": { + "enum": [ + "INCLUDE", + "EXCLUDE", + "ONLY" + ], + "type": "string" + }, "from": { "oneOf": [ { @@ -1492,6 +1580,9 @@ }, { "$ref": "#/components/schemas/RelativeDateFilter" + }, + { + "$ref": "#/components/schemas/AllTimeDateFilter" } ], "type": "object" @@ -1696,6 +1787,9 @@ { "$ref": "#/components/schemas/RelativeDateFilter" }, + { + "$ref": "#/components/schemas/AllTimeDateFilter" + }, { "$ref": "#/components/schemas/NegativeAttributeFilter" }, @@ -1949,9 +2043,9 @@ } }, "required": [ + "label", "literal", - "matchType", - "label" + "matchType" ], "type": "object" } @@ -2044,6 +2138,22 @@ ], "type": "object" }, + "MetricDefinitionOverride": { + "description": "(EXPERIMENTAL) Override for a catalog metric definition.", + "properties": { + "definition": { + "$ref": "#/components/schemas/InlineMeasureDefinition" + }, + "item": { + "$ref": "#/components/schemas/AfmObjectIdentifierCore" + } + }, + "required": [ + "definition", + "item" + ], + "type": "object" + }, "MetricRecord": { "properties": { "formattedValue": { @@ -2078,8 +2188,8 @@ } }, "required": [ - "notIn", - "label" + "label", + "notIn" ], "type": "object" } @@ -2533,9 +2643,9 @@ }, "required": [ "from", + "measure", "operator", - "to", - "measure" + "to" ], "type": "object" } @@ -2786,6 +2896,16 @@ "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, @@ -2829,10 +2949,10 @@ } }, "required": [ + "dataset", "from", "granularity", - "to", - "dataset" + "to" ], "type": "object" } diff --git a/schemas/gooddata-export-client.json b/schemas/gooddata-export-client.json index 9180ea1f8..59f86d5ed 100644 --- a/schemas/gooddata-export-client.json +++ b/schemas/gooddata-export-client.json @@ -25,6 +25,13 @@ }, "type": "array" }, + "measureDefinitionOverrides": { + "description": "(EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric's MAQL definition without modifying the stored definition.", + "items": { + "$ref": "#/components/schemas/MetricDefinitionOverride" + }, + "type": "array" + }, "measures": { "description": "Metrics to be computed.", "items": { @@ -51,6 +58,16 @@ "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": { "example": "2020-07-01 18:23", "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", @@ -66,9 +83,9 @@ } }, "required": [ + "dataset", "from", - "to", - "dataset" + "to" ], "type": "object" } @@ -277,6 +294,69 @@ ], "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": { + "allTimeDateFilter": { + "properties": { + "applyOnResult": { + "type": "boolean" + }, + "dataset": { + "$ref": "#/components/schemas/AfmObjectIdentifierDataset" + }, + "emptyValueHandling": { + "default": "INCLUDE", + "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE means no filtering effect (default), EXCLUDE removes rows with null dates, ONLY keeps only rows with null dates.", + "enum": [ + "INCLUDE", + "EXCLUDE", + "ONLY" + ], + "type": "string" + }, + "granularity": { + "default": "DAY", + "description": "Date granularity used to resolve the date attribute label for null value checks. Defaults to DAY if not specified.", + "enum": [ + "MINUTE", + "HOUR", + "DAY", + "WEEK", + "MONTH", + "QUARTER", + "YEAR", + "MINUTE_OF_HOUR", + "HOUR_OF_DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK_OF_YEAR", + "MONTH_OF_YEAR", + "QUARTER_OF_YEAR", + "FISCAL_MONTH", + "FISCAL_QUARTER", + "FISCAL_YEAR" + ], + "example": "DAY", + "type": "string" + }, + "localIdentifier": { + "type": "string" + } + }, + "required": [ + "dataset" + ], + "type": "object" + } + }, + "required": [ + "allTimeDateFilter" + ], + "type": "object" + }, "ArithmeticMeasureDefinition": { "description": "Metric representing arithmetics between other metrics.", "properties": { @@ -574,9 +654,9 @@ } }, "required": [ + "measure", "operator", - "value", - "measure" + "value" ], "type": "object" } @@ -754,6 +834,14 @@ "dataSet": { "$ref": "#/components/schemas/IdentifierRef" }, + "emptyValueHandling": { + "enum": [ + "INCLUDE", + "EXCLUDE", + "ONLY" + ], + "type": "string" + }, "from": { "oneOf": [ { @@ -939,6 +1027,9 @@ }, { "$ref": "#/components/schemas/RelativeDateFilter" + }, + { + "$ref": "#/components/schemas/AllTimeDateFilter" } ], "type": "object" @@ -1009,6 +1100,9 @@ { "$ref": "#/components/schemas/RelativeDateFilter" }, + { + "$ref": "#/components/schemas/AllTimeDateFilter" + }, { "$ref": "#/components/schemas/NegativeAttributeFilter" }, @@ -1218,9 +1312,9 @@ } }, "required": [ + "label", "literal", - "matchType", - "label" + "matchType" ], "type": "object" } @@ -1294,6 +1388,22 @@ ], "type": "object" }, + "MetricDefinitionOverride": { + "description": "(EXPERIMENTAL) Override for a catalog metric definition.", + "properties": { + "definition": { + "$ref": "#/components/schemas/InlineMeasureDefinition" + }, + "item": { + "$ref": "#/components/schemas/AfmObjectIdentifierCore" + } + }, + "required": [ + "definition", + "item" + ], + "type": "object" + }, "NegativeAttributeFilter": { "description": "Filter able to limit element values by label and related selected negated elements.", "properties": { @@ -1313,8 +1423,8 @@ } }, "required": [ - "notIn", - "label" + "label", + "notIn" ], "type": "object" } @@ -1603,9 +1713,9 @@ }, "required": [ "from", + "measure", "operator", - "to", - "measure" + "to" ], "type": "object" } @@ -1817,6 +1927,16 @@ "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, @@ -1860,10 +1980,10 @@ } }, "required": [ + "dataset", "from", "granularity", - "to", - "dataset" + "to" ], "type": "object" } diff --git a/schemas/gooddata-metadata-client.json b/schemas/gooddata-metadata-client.json index 9597ef2a6..baaa8cc58 100644 --- a/schemas/gooddata-metadata-client.json +++ b/schemas/gooddata-metadata-client.json @@ -70,6 +70,13 @@ }, "type": "array" }, + "measureDefinitionOverrides": { + "description": "(EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric's MAQL definition without modifying the stored definition.", + "items": { + "$ref": "#/components/schemas/MetricDefinitionOverride" + }, + "type": "array" + }, "measures": { "description": "Metrics to be computed.", "items": { @@ -4459,6 +4466,16 @@ "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": { "example": "2020-07-01 18:23", "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", @@ -4474,9 +4491,9 @@ } }, "required": [ + "dataset", "from", - "to", - "dataset" + "to" ], "type": "object" } @@ -4755,6 +4772,69 @@ ], "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": { + "allTimeDateFilter": { + "properties": { + "applyOnResult": { + "type": "boolean" + }, + "dataset": { + "$ref": "#/components/schemas/AfmObjectIdentifierDataset" + }, + "emptyValueHandling": { + "default": "INCLUDE", + "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE means no filtering effect (default), EXCLUDE removes rows with null dates, ONLY keeps only rows with null dates.", + "enum": [ + "INCLUDE", + "EXCLUDE", + "ONLY" + ], + "type": "string" + }, + "granularity": { + "default": "DAY", + "description": "Date granularity used to resolve the date attribute label for null value checks. Defaults to DAY if not specified.", + "enum": [ + "MINUTE", + "HOUR", + "DAY", + "WEEK", + "MONTH", + "QUARTER", + "YEAR", + "MINUTE_OF_HOUR", + "HOUR_OF_DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK_OF_YEAR", + "MONTH_OF_YEAR", + "QUARTER_OF_YEAR", + "FISCAL_MONTH", + "FISCAL_QUARTER", + "FISCAL_YEAR" + ], + "example": "DAY", + "type": "string" + }, + "localIdentifier": { + "type": "string" + } + }, + "required": [ + "dataset" + ], + "type": "object" + } + }, + "required": [ + "allTimeDateFilter" + ], + "type": "object" + }, "AnomalyDetection": { "properties": { "dataset": { @@ -5288,6 +5368,146 @@ ], "type": "object" }, + "AwsBedrockAccessKeyAuth": { + "allOf": [ + { + "properties": { + "accessKeyId": { + "description": "AWS Access Key ID.", + "maxLength": 255, + "nullable": true, + "type": "string", + "writeOnly": true + }, + "secretAccessKey": { + "description": "AWS Secret Access Key.", + "maxLength": 10000, + "nullable": true, + "type": "string", + "writeOnly": true + }, + "sessionToken": { + "description": "AWS Session Token (for temporary credentials).", + "maxLength": 10000, + "nullable": true, + "type": "string", + "writeOnly": true + }, + "type": { + "description": "Authentication type.", + "enum": [ + "ACCESS_KEY" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "required": [ + "type" + ], + "type": "object" + }, + "AwsBedrockProviderConfig": { + "description": "Configuration for AWS Bedrock provider.", + "properties": { + "auth": { + "$ref": "#/components/schemas/BedrockProviderAuth" + }, + "region": { + "description": "AWS region for Bedrock.", + "example": "us-east-1", + "maxLength": 255, + "type": "string" + }, + "type": { + "description": "Provider type.", + "enum": [ + "AWS_BEDROCK" + ], + "type": "string" + } + }, + "required": [ + "auth", + "region", + "type" + ], + "type": "object" + }, + "AzureFoundryApiKeyAuth": { + "allOf": [ + { + "properties": { + "apiKey": { + "description": "Azure 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" + }, + "AzureFoundryProviderAuth": { + "description": "Authentication configuration.", + "oneOf": [ + { + "$ref": "#/components/schemas/AzureFoundryApiKeyAuth" + } + ], + "type": "object" + }, + "AzureFoundryProviderConfig": { + "description": "Configuration for Azure Foundry provider.", + "properties": { + "auth": { + "$ref": "#/components/schemas/AzureFoundryProviderAuth" + }, + "endpoint": { + "description": "Azure AI inference endpoint URL.", + "example": "https://my-resource.services.ai.azure.com/models", + "maxLength": 255, + "type": "string" + }, + "type": { + "description": "Provider type.", + "enum": [ + "AZURE_FOUNDRY" + ], + "type": "string" + } + }, + "required": [ + "auth", + "endpoint", + "type" + ], + "type": "object" + }, + "BedrockProviderAuth": { + "description": "Authentication configuration.", + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockAccessKeyAuth" + } + ], + "type": "object" + }, "BoundedFilter": { "description": "Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range.", "properties": { @@ -5484,9 +5704,9 @@ } }, "required": [ + "measure", "operator", - "value", - "measure" + "value" ], "type": "object" } @@ -5716,6 +5936,14 @@ "dataSet": { "$ref": "#/components/schemas/IdentifierRef" }, + "emptyValueHandling": { + "enum": [ + "INCLUDE", + "EXCLUDE", + "ONLY" + ], + "type": "string" + }, "from": { "oneOf": [ { @@ -6129,6 +6357,9 @@ }, { "$ref": "#/components/schemas/RelativeDateFilter" + }, + { + "$ref": "#/components/schemas/AllTimeDateFilter" } ], "type": "object" @@ -6216,6 +6447,27 @@ }, "DeclarativeAnalyticalDashboard": { "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/JsonNode" }, @@ -6603,7 +6855,7 @@ }, "createdAt": { "description": "Time of the entity creation.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -6625,7 +6877,7 @@ }, "modifiedAt": { "description": "Time of the last entity modification.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -6991,7 +7243,7 @@ }, "createdAt": { "description": "Time of the entity creation.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -7013,7 +7265,7 @@ }, "modifiedAt": { "description": "Time of the last entity modification.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -7481,7 +7733,7 @@ "properties": { "createdAt": { "description": "Time of the entity creation.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -7503,7 +7755,7 @@ }, "modifiedAt": { "description": "Time of the last entity modification.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -8175,12 +8427,33 @@ }, "DeclarativeMetric": { "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/JsonNode" }, "createdAt": { "description": "Time of the entity creation.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -8212,7 +8485,7 @@ }, "modifiedAt": { "description": "Time of the last entity modification.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -8751,6 +9024,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -8793,7 +9067,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "example": "TIMEZONE", "type": "string" @@ -8819,6 +9094,8 @@ "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", + "WRITE_KNOWLEDGE_DOCUMENTS", + "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], @@ -9256,12 +9533,33 @@ }, "DeclarativeVisualizationObject": { "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/JsonNode" }, "createdAt": { "description": "Time of the entity creation.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -9288,7 +9586,7 @@ }, "modifiedAt": { "description": "Time of the last entity modification.", - "example": "[\"2023-07-20 12:30\"]", + "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" @@ -9612,6 +9910,8 @@ "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", + "WRITE_KNOWLEDGE_DOCUMENTS", + "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], @@ -9777,6 +10077,15 @@ "$ref": "#/components/schemas/EntityIdentifier" }, "type": "array" + }, + "relation": { + "default": "DEPENDENTS", + "description": "Entity relation for graph traversal from the entry points. DEPENDENTS returns entities that depend on the entry points. DEPENDENCIES returns entities that the entry points depend on.", + "enum": [ + "DEPENDENTS", + "DEPENDENCIES" + ], + "type": "string" } }, "required": [ @@ -10110,6 +10419,9 @@ { "$ref": "#/components/schemas/RelativeDateFilter" }, + { + "$ref": "#/components/schemas/AllTimeDateFilter" + }, { "$ref": "#/components/schemas/NegativeAttributeFilter" }, @@ -10936,6 +11248,26 @@ "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": { @@ -10949,6 +11281,7 @@ }, "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}", @@ -10960,6 +11293,7 @@ }, "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}", @@ -11055,6 +11389,17 @@ ], "type": "object" }, + "certifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "createdBy": { "properties": { "data": { @@ -11668,6 +12013,7 @@ }, "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}", @@ -11679,6 +12025,7 @@ }, "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}", @@ -12691,6 +13038,7 @@ }, "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}", @@ -12778,6 +13126,7 @@ }, "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}", @@ -14677,6 +15026,7 @@ }, "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}", @@ -14688,6 +15038,7 @@ }, "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}", @@ -16391,6 +16742,7 @@ }, "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}", @@ -16402,6 +16754,7 @@ }, "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}", @@ -20362,6 +20715,369 @@ ], "type": "object" }, + "JsonApiLlmProviderIn": { + "description": "LLM Provider configuration for connecting to LLM services.", + "properties": { + "attributes": { + "properties": { + "defaultModelId": { + "description": "ID of the default model to use from the models list.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "description": { + "description": "Description of the LLM Provider.", + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "models": { + "description": "List of LLM models available for this provider.", + "items": { + "description": "LLM Model configuration (id, family) within a provider.", + "properties": { + "family": { + "description": "Family of LLM models.", + "enum": [ + "OPENAI", + "ANTHROPIC", + "META", + "MISTRAL", + "AMAZON", + "GOOGLE", + "COHERE" + ], + "type": "string" + }, + "id": { + "description": "Unique identifier of the model (e.g., gpt-5.3, claude-4.6).", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "family", + "id" + ], + "type": "object" + }, + "nullable": true, + "type": "array" + }, + "name": { + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "providerConfig": { + "description": "Provider-specific configuration including authentication.", + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockProviderConfig" + }, + { + "$ref": "#/components/schemas/AzureFoundryProviderConfig" + }, + { + "$ref": "#/components/schemas/OpenAIProviderConfig" + } + ] + } + }, + "required": [ + "models", + "providerConfig" + ], + "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": [ + "llmProvider" + ], + "example": "llmProvider", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiLlmProviderInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiLlmProviderIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiLlmProviderOut": { + "description": "LLM Provider configuration for connecting to LLM services.", + "properties": { + "attributes": { + "properties": { + "defaultModelId": { + "description": "ID of the default model to use from the models list.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "description": { + "description": "Description of the LLM Provider.", + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "models": { + "description": "List of LLM models available for this provider.", + "items": { + "description": "LLM Model configuration (id, family) within a provider.", + "properties": { + "family": { + "description": "Family of LLM models.", + "enum": [ + "OPENAI", + "ANTHROPIC", + "META", + "MISTRAL", + "AMAZON", + "GOOGLE", + "COHERE" + ], + "type": "string" + }, + "id": { + "description": "Unique identifier of the model (e.g., gpt-5.3, claude-4.6).", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "family", + "id" + ], + "type": "object" + }, + "nullable": true, + "type": "array" + }, + "name": { + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "providerConfig": { + "description": "Provider-specific configuration including authentication.", + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockProviderConfig" + }, + { + "$ref": "#/components/schemas/AzureFoundryProviderConfig" + }, + { + "$ref": "#/components/schemas/OpenAIProviderConfig" + } + ] + } + }, + "required": [ + "models", + "providerConfig" + ], + "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": [ + "llmProvider" + ], + "example": "llmProvider", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiLlmProviderOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiLlmProviderOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiLlmProviderOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiLlmProviderOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiLlmProviderOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiLlmProviderPatch": { + "description": "LLM Provider configuration for connecting to LLM services.", + "properties": { + "attributes": { + "properties": { + "defaultModelId": { + "description": "ID of the default model to use from the models list.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "description": { + "description": "Description of the LLM Provider.", + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "models": { + "description": "List of LLM models available for this provider.", + "items": { + "description": "LLM Model configuration (id, family) within a provider.", + "properties": { + "family": { + "description": "Family of LLM models.", + "enum": [ + "OPENAI", + "ANTHROPIC", + "META", + "MISTRAL", + "AMAZON", + "GOOGLE", + "COHERE" + ], + "type": "string" + }, + "id": { + "description": "Unique identifier of the model (e.g., gpt-5.3, claude-4.6).", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "family", + "id" + ], + "type": "object" + }, + "nullable": true, + "type": "array" + }, + "name": { + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "providerConfig": { + "description": "Provider-specific configuration including authentication.", + "oneOf": [ + { + "$ref": "#/components/schemas/AwsBedrockProviderConfig" + }, + { + "$ref": "#/components/schemas/AzureFoundryProviderConfig" + }, + { + "$ref": "#/components/schemas/OpenAIProviderConfig" + } + ] + } + }, + "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": [ + "llmProvider" + ], + "example": "llmProvider", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiLlmProviderPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiLlmProviderPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "JsonApiMemoryItemIn": { "description": "JSON:API representation of memoryItem entity.", "properties": { @@ -20458,6 +21174,7 @@ }, "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}", @@ -20485,6 +21202,7 @@ }, "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}", @@ -20944,6 +21662,26 @@ "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": { "properties": { "format": { @@ -20972,6 +21710,7 @@ }, "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}", @@ -20989,6 +21728,7 @@ }, "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}", @@ -21055,6 +21795,17 @@ ], "type": "object" }, + "certifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "createdBy": { "properties": { "data": { @@ -22391,6 +23142,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -22433,7 +23185,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -22488,6 +23241,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -22530,7 +23284,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -22625,6 +23380,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -22667,7 +23423,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -24128,6 +24885,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -24170,7 +24928,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -24225,6 +24984,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -24267,7 +25027,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -24464,6 +25225,26 @@ "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": { @@ -24477,6 +25258,7 @@ }, "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}", @@ -24491,6 +25273,7 @@ }, "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}", @@ -24557,6 +25340,17 @@ ], "type": "object" }, + "certifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "createdBy": { "properties": { "data": { @@ -26203,6 +26997,8 @@ "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", + "WRITE_KNOWLEDGE_DOCUMENTS", + "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], @@ -26443,6 +27239,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -26485,7 +27282,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -26540,6 +27338,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -26582,7 +27381,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -26703,6 +27503,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -26745,7 +27546,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -26800,6 +27602,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -26842,7 +27645,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "type": "string" } @@ -26937,6 +27741,17 @@ } ] }, + "LlmProviderAuth": { + "properties": { + "type": { + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, "LocalIdentifier": { "properties": { "format": { @@ -27018,9 +27833,9 @@ } }, "required": [ + "label", "literal", - "matchType", - "label" + "matchType" ], "type": "object" } @@ -27094,6 +27909,22 @@ ], "type": "object" }, + "MetricDefinitionOverride": { + "description": "(EXPERIMENTAL) Override for a catalog metric definition.", + "properties": { + "definition": { + "$ref": "#/components/schemas/InlineMeasureDefinition" + }, + "item": { + "$ref": "#/components/schemas/AfmObjectIdentifierCore" + } + }, + "required": [ + "definition", + "item" + ], + "type": "object" + }, "NegativeAttributeFilter": { "description": "Filter able to limit element values by label and related selected negated elements.", "properties": { @@ -27113,8 +27944,8 @@ } }, "required": [ - "notIn", - "label" + "label", + "notIn" ], "type": "object" } @@ -27212,6 +28043,75 @@ }, "type": "object" }, + "OpenAIProviderConfig": { + "description": "Configuration for OpenAI provider.", + "properties": { + "auth": { + "$ref": "#/components/schemas/OpenAiProviderAuth" + }, + "baseUrl": { + "default": "https://api.openai.com", + "description": "Custom base URL for OpenAI API.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "organization": { + "description": "OpenAI organization ID.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "type": { + "description": "Provider type.", + "enum": [ + "OPENAI" + ], + "type": "string" + } + }, + "required": [ + "auth", + "type" + ], + "type": "object" + }, + "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" + }, "OrganizationAutomationIdentifier": { "properties": { "id": { @@ -27771,9 +28671,9 @@ }, "required": [ "from", + "measure", "operator", - "to", - "measure" + "to" ], "type": "object" } @@ -28081,6 +28981,16 @@ "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, @@ -28124,10 +29034,10 @@ } }, "required": [ + "dataset", "from", "granularity", - "to", - "dataset" + "to" ], "type": "object" } @@ -28185,6 +29095,7 @@ "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", + "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", @@ -28227,7 +29138,8 @@ "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI" + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS" ], "example": "TIMEZONE", "type": "string" @@ -28252,6 +29164,8 @@ "type": "string" }, "kid": { + "maxLength": 255, + "pattern": "^[^.]", "type": "string" }, "kty": { @@ -28345,6 +29259,43 @@ }, "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" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, "Settings": { "description": "Additional settings.", "properties": { @@ -29039,6 +29990,8 @@ "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", + "WRITE_KNOWLEDGE_DOCUMENTS", + "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], @@ -29063,6 +30016,8 @@ "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", + "WRITE_KNOWLEDGE_DOCUMENTS", + "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], @@ -29337,6 +30292,8 @@ "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", + "WRITE_KNOWLEDGE_DOCUMENTS", + "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], @@ -29354,6 +30311,8 @@ "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", + "WRITE_KNOWLEDGE_DOCUMENTS", + "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], @@ -31506,6 +32465,48 @@ } } }, + "/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", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SetCertificationRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + } + }, + "summary": "Set Certification", + "tags": [ + "actions", + "Certification" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/actions/workspaces/{workspaceId}/translations": { "get": { "description": "Provides a list of effective translation tags.", @@ -34704,7 +35705,7 @@ "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;provider==LLMProviderValue", + "example": "title==someString;provider==LlmEndpointProviderValue", "in": "query", "name": "filter", "schema": { @@ -34818,7 +35819,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;provider==LLMProviderValue", + "example": "title==someString;provider==LlmEndpointProviderValue", "in": "query", "name": "filter", "schema": { @@ -34845,7 +35846,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;provider==LLMProviderValue", + "example": "title==someString;provider==LlmEndpointProviderValue", "in": "query", "name": "filter", "schema": { @@ -34885,7 +35886,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;provider==LLMProviderValue", + "example": "title==someString;provider==LlmEndpointProviderValue", "in": "query", "name": "filter", "schema": { @@ -34940,7 +35941,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;provider==LLMProviderValue", + "example": "title==someString;provider==LlmEndpointProviderValue", "in": "query", "name": "filter", "schema": { @@ -34988,6 +35989,298 @@ ] } }, + "/api/v1/entities/llmProviders": { + "get": { + "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;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": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all LLM Provider entities", + "tags": [ + "LLM Providers", + "entities", + "organization-model-controller" + ] + }, + "post": { + "description": "LLM Provider - connection configuration for LLM services", + "operationId": "createEntity@LlmProviders", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post LLM Provider entities", + "tags": [ + "LLM Providers", + "entities", + "organization-model-controller" + ] + } + }, + "/api/v1/entities/llmProviders/{id}": { + "delete": { + "operationId": "deleteEntity@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;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete LLM Provider entity", + "tags": [ + "LLM Providers", + "entities", + "organization-model-controller" + ] + }, + "get": { + "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;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get LLM Provider entity", + "tags": [ + "LLM Providers", + "entities", + "organization-model-controller" + ] + }, + "patch": { + "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;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch LLM Provider entity", + "tags": [ + "LLM Providers", + "entities", + "organization-model-controller" + ] + }, + "put": { + "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;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "PUT LLM Provider entity", + "tags": [ + "LLM Providers", + "entities", + "organization-model-controller" + ] + } + }, "/api/v1/entities/notificationChannelIdentifiers": { "get": { "operationId": "getAllEntities@NotificationChannelIdentifiers", @@ -38490,7 +39783,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", "explode": false, "in": "query", "name": "include", @@ -38508,6 +39801,7 @@ "dashboardPlugins", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -38603,7 +39897,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", "explode": false, "in": "query", "name": "include", @@ -38621,6 +39915,7 @@ "dashboardPlugins", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -38857,7 +40152,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", "explode": false, "in": "query", "name": "include", @@ -38875,6 +40170,7 @@ "dashboardPlugins", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -38977,7 +40273,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", "explode": false, "in": "query", "name": "include", @@ -38995,6 +40291,7 @@ "dashboardPlugins", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -39079,7 +40376,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", "explode": false, "in": "query", "name": "include", @@ -39097,6 +40394,7 @@ "dashboardPlugins", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -46637,7 +47935,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -46653,6 +47951,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -46746,7 +48045,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -46762,6 +48061,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -46996,7 +48296,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -47012,6 +48312,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -47112,7 +48413,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -47128,6 +48429,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -47212,7 +48514,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -47228,6 +48530,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -47968,7 +49271,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -47984,6 +49287,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -48077,7 +49381,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -48093,6 +49397,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -48327,7 +49632,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -48343,6 +49648,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -48443,7 +49749,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -48459,6 +49765,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -48543,7 +49850,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" 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,facts,attributes,labels,metrics,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets", "explode": false, "in": "query", "name": "include", @@ -48559,6 +49866,7 @@ "datasets", "createdBy", "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" diff --git a/scripts/generate_client.sh b/scripts/generate_client.sh index a83274fa7..f3ea6e587 100755 --- a/scripts/generate_client.sh +++ b/scripts/generate_client.sh @@ -127,7 +127,7 @@ docker run --rm \ -v "${ROOT_DIR}:/local" \ -u $(id -u ${USER}):$(id -g ${USER}) \ ${CONN_NETWORK_ARG} \ - openapitools/openapi-generator-cli:v6.0.1 generate \ + openapitools/openapi-generator-cli:v6.6.0 generate \ -c "/local/.openapi-generator/configs/${GD_API_CLIENT}.yaml" \ -i "${GD_API_URI_PATH}" \ -o "/local/${GD_API_CLIENT}"